Rnd Class
Properties Methods Events Config Settings Errors
The Rnd class class is a basic provider of random number generation functionality.
Syntax
class secureblackbox.Rnd
Remarks
Use Rnd control to generate pseudo-random numbers or sequences. Methods like next_bytes and next_int return the next PRNG output, whereas seed_bytes or seed_int seed the generator with outside entropy.
It is a good idea to use one shared (singleton) Rnd object per process, as it helps spread the entropy across many part of the project,
resulting in better and more secure randomization.
RND random = new RND();
// Random password
System.out.println(random.nextPass(true,true,true,true,16));
// Output: O7#}?XL26#Gy8aYS
// Generating a hex string
random.setAlphabet("abcdef1234567890"); // Setting the characters to create a hex string
System.out.println(random.nextString(16));
// Output: 8b40f2e93427286b
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| alphabet | Alphabet to use for random string generation. |
| fips_mode | Reserved. |
| source | Sets the source of random data. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| next_bytes | Generates an array of random bytes. |
| next_int | Generates a random integer. |
| next_pass | Generates a random password. |
| next_string | Generates a random string of characters. |
| randomize | Seeds the random generator with a system-originating input. |
| reset | Resets the class settings. |
| seed_bytes | Seeds the generator with a data in a byte array. |
| seed_int | Seeds the generator with an integer value. |
| seed_string | Seeds the generator with a string value. |
| seed_time | Seeds the generator with current time. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Informs about errors during cryptographic operations. |
| on_notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
alphabet Property
Alphabet to use for random string generation.
Syntax
def get_alphabet() -> str: ... def set_alphabet(value: str) -> None: ...
alphabet = property(get_alphabet, set_alphabet)
Default Value
""
Remarks
Use this property to provide a list of characters to be used by next_string method. The empty value has a special meaning, and is equivalent to 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'.
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
source Property
Sets the source of random data.
Syntax
def get_source() -> int: ... def set_source(value: int) -> None: ...
source = property(get_source, set_source)
Default Value
3
Remarks
Use this property to specify the source of random data to be used by the class.
| rndUnknown | 0 | The generator is not configured or the configuration is not supported |
| rndBuiltIn | 1 | Use only the built-in random generator |
| rndSystem | 2 | Use only the target system's random generator |
| rndBoth | 3 | Use both internal and system random generators |
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
next_bytes Method
Generates an array of random bytes.
Syntax
def next_bytes(len: int) -> bytes: ...
Remarks
Call this method to generate an array of random bytes of length Len.
next_int Method
Generates a random integer.
Syntax
def next_int() -> int: ...
Remarks
Use this method to generate a random integer value.
next_pass Method
Generates a random password.
Syntax
def next_pass(lowercase: bool, uppercase: bool, digits: bool, specials: bool, len: int) -> str: ...
Remarks
Use this method to generate a random password. Tune up the desired length and composition of the password using Lowercase, Uppercase, Digits, Specials, and Len parameters.
next_string Method
Generates a random string of characters.
Syntax
def next_string(len: int) -> str: ...
Remarks
Use this method to generate a random string using characters supplied via the alphabet property.
randomize Method
Seeds the random generator with a system-originating input.
Syntax
def randomize() -> None: ...
Remarks
Use this method to randomize the generator by seeding it with a system-produced random input.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
seed_bytes Method
Seeds the generator with a data in a byte array.
Syntax
def seed_bytes(value: bytes) -> None: ...
Remarks
Use this method to seed the generator with data provided in a byte array.
seed_int Method
Seeds the generator with an integer value.
Syntax
def seed_int(int_value: int) -> None: ...
Remarks
Use this method to seed the generator with an integer value.
seed_string Method
Seeds the generator with a string value.
Syntax
def seed_string(str_value: str) -> None: ...
Remarks
Use this method to seed the generator with a string value.
seed_time Method
Seeds the generator with current time.
Syntax
def seed_time() -> None: ...
Remarks
Use this method to seed the generator with current system time.
on_error Event
Informs about errors during cryptographic operations.
Syntax
class RndErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class Rnd: @property def on_error() -> Callable[[RndErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[RndErrorEventParams], None]) -> None: ...
Remarks
Class fires this event if an error happens during a cryptographic operation.
ErrorCode contains an error code and Description contains a textual description of the error that happened.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class RndNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class Rnd: @property def on_notification() -> Callable[[RndNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[RndNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
Rnd Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
| time | Current time | |
| level | Level | |
| package | Package name | |
| module | Module name | |
| class | Class name | |
| method | Method name | |
| threadid | Thread Id | |
| contenttype | Content type | |
| content | Content | |
| all | All details |
Supported filter names are:
| exclude-package | Exclude a package specified in the value | |
| exclude-module | Exclude a module specified in the value | |
| exclude-class | Exclude a class specified in the value | |
| exclude-method | Exclude a method specified in the value | |
| include-package | Include a package specified in the value | |
| include-module | Include a module specified in the value | |
| include-class | Include a class specified in the value | |
| include-method | Include a method specified in the value |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
| none | None (by default) | |
| fatal | Severe errors that cause premature termination. | |
| error | Other runtime errors or unexpected conditions. | |
| warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
| info | Interesting runtime events (startup/shutdown). | |
| debug | Detailed information on flow of through the system. | |
| trace | More detailed information. |
The default value of this setting is 100.
| none | No rotation | |
| deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
| keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Rnd Errors
Rnd Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |