class OpenSSL::BN

Public Class Methods

(::Integer bits, ?boolish safe, ?bn add, ?bn rem) → instance

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1530
def self.generate_prime: (::Integer bits, ?boolish safe, ?bn add, ?bn rem) -> instance

Generates a random prime number of bit length bits. If safe is set to true, generates a safe prime. If add is specified, generates a prime that fulfills condition p % add = rem.

Parameters

bits - integer
safe - boolean
add - BN
rem - BN

new

(self) → void
(Integer) → void
(string) → void
(string, 0 | 2 | 10 | 16) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1942
def initialize: (self) -> void
                  | (Integer) -> void
                  | (string) -> void
                  | (string, 0 | 2 | 10 | 16) -> void

Construct a new OpenSSL BIGNUM object.

If bn is an Integer or OpenSSL::BN, a new instance of OpenSSL::BN representing the same value is returned. See also Integer#to_bn for the short-hand.

If a String is given, the content will be parsed according to base.

string: The string to be parsed.
base: The format. Must be one of the following: * 0 - MPI format. See the man page BN_mpi2bn(3) for details. * 2 - Variable-length and big-endian binary encoding of a positive number. * 10 - Decimal number representation, with a leading ‘-’ for a negative number. * 16 - Hexadecimal number representation, with a leading ‘-’ for a negative number.

pseudo_rand

(*untyped) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1532
def self.pseudo_rand: (*untyped) -> untyped

pseudo_rand_range

(untyped) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1534
def self.pseudo_rand_range: (untyped) -> untyped

rand

(*untyped) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1544
def self.rand: (*untyped) -> untyped

Generates a cryptographically strong pseudo-random number of bits.

Public Instance Methods

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1562
def %: (bn) -> self

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1569
def *: (bn) -> self

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1576
def **: (bn) -> self

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1583
def +: (bn) -> self

() → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1590
def +@: () -> self

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1597
def -: (bn) -> self

() → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1604
def -@: () -> self

(bn) → [ self, self ]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1612
def /: (bn) -> [ self, self ]

Division of OpenSSL::BN instances

(int) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1619
def <<: (int) -> self

<=>

(bn) → Integer

Alias for: cmp

(untyped) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1635
def ==: (untyped) -> bool

Returns true only if obj has the same value as bn. Contrast this with OpenSSL::BN#eql?, which requires obj to be OpenSSL::BN.

Also aliased as: ===

===

(untyped) → bool

Returns true only if obj has the same value as bn. Contrast this with OpenSSL::BN#eql?, which requires obj to be OpenSSL::BN.

Alias for: ==

(int) → int

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1648
def >>: (int) -> int

bit_set?

(int) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1656
def bit_set?: (int) -> bool

Tests bit bit in bn and returns true if set, false if not set.

clear_bit!

(int) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1663
def clear_bit!: (int) -> void

cmp

(bn) → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1670
def cmp: (bn) -> Integer

Also aliased as: <=>

coerce

(::Integer) → Array[Integer]
(BN) → Array[BN]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1677
def coerce: (::Integer) -> Array[Integer]
              | (BN) -> Array[BN]

copy

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1685
def copy: (bn) -> self

eql?

(untyped other) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1694
def eql?: (untyped other) -> bool

Returns true only if obj is a OpenSSL::BN with the same value as bn. Contrast this with OpenSSL::BN#==, which performs type conversions.

gcd

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1701
def gcd: (bn) -> self

hash

() → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1711
def hash: () -> Integer

Returns a hash code for this object.

See also Object#hash.

initialize_copy

(self other) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1952
def initialize_copy: (self other) -> self

lshift!

(int bits) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1718
def lshift!: (int bits) -> self

mask_bits!

(int) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1720
def mask_bits!: (int) -> void

mod_add

(bn, bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1727
def mod_add: (bn, bn) -> self

mod_exp

(bn, bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1734
def mod_exp: (bn, bn) -> self

mod_inverse

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1741
def mod_inverse: (bn) -> self

mod_mul

(bn, bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1748
def mod_mul: (bn, bn) -> self

mod_sqr

(bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1755
def mod_sqr: (bn) -> self

mod_sub

(bn, bn) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1762
def mod_sub: (bn, bn) -> self

negative?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1769
def negative?: () -> bool

num_bits

() → ::Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1776
def num_bits: () -> ::Integer

num_bytes

() → ::Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1783
def num_bytes: () -> ::Integer

odd?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1790
def odd?: () -> bool

one?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1797
def one?: () -> bool

pretty_print

(untyped q) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1804
def pretty_print: (untyped q) -> untyped

prime?

(?int checks) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1816
def prime?: (?int checks) -> bool

Performs a Miller-Rabin probabilistic primality test for bn.

<strong>checks parameter is deprecated in version 3.0.</strong> It has no effect.

prime_fasttest?

(?int checks, ?int trial_div) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1830
def prime_fasttest?: (?int checks, ?int trial_div) -> bool

Performs a Miller-Rabin probabilistic primality test for bn.

<strong>Deprecated in version 3.0.</strong> Use prime? instead.

checks and trial_div parameters no longer have any effect.

rshift!

(int bits) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1837
def rshift!: (int bits) -> self

set_bit!

(int bit) → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1844
def set_bit!: (int bit) -> self

sqr

() → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1851
def sqr: () -> self

to_bn

() → self

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1858
def to_bn: () -> self

to_i

() → ::Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1865
def to_i: () -> ::Integer

Also aliased as: to_int

to_int

() → ::Integer

Alias for: to_i

to_s

() → String
(0) → String
(2) → String
(10) → String
(16) → String
(int base) → String

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1892
def to_s: () -> String
            | (0) -> String
            | (2) -> String
            | (10) -> String
            | (16) -> String
            | (int base) -> String

Returns the string representation of the bignum.

BN.new can parse the encoded string to convert back into an OpenSSL::BN.

base: The format. Must be one of the following: * 0 - MPI format. See the man page BN_bn2mpi(3) for details. * 2 - Variable-length and big-endian binary encoding. The sign of the bignum is ignored. * 10 - Decimal number representation, with a leading ‘-’ for a negative bignum. * 16 - Hexadecimal number representation, with a leading ‘-’ for a negative bignum.

ucmp

(bn bn2) → ::Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1904
def ucmp: (bn bn2) -> ::Integer

zero?

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/stdlib/openssl/0/openssl.rbs, line 1911
def zero?: () -> bool