Pointy Castle

https://pub.dev/documentation/pointycastle/latest
Admin
A Dart library for encryption and decryption, porting many algorithms from Bouncy Castle Java, with...
Tokens:543,606
Snippets:3,566
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Instantiate Register64

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha384/SHA384Digest/h5.html

Demonstrates how to create an instance of the Register64 class. This is a basic setup for using the Register64 functionality.

```dart
final h5 = Register64();
```

--------------------------------

### Get n property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDomainParameters/n.html

Retrieves the BigInt value of the 'n' property. No specific setup is required.

```dart
BigInt get n;
```

--------------------------------

### init abstract method

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDHAgreement/init.html

Initializes the agreement engine with an ECPrivateKey.

```APIDOC
## void init(ECPrivateKey param)

### Description
Initialises the agreement engine.

### Method
N/A (Abstract Method)

### Endpoint
N/A (Abstract Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
None

#### Response Example
None
```

--------------------------------

### Get ECCurve Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDomainParameters/curve.html

Retrieves the ECCurve object. No specific setup is required beyond having an instance that exposes this property.

```csharp
ECCurve get curve;
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/ecc_ecdh/ECDHBasicAgreement/init.html

Initializes the agreement engine with an ECPrivateKey.

```APIDOC
## init method

### Description
Initialises the agreement engine with an ECPrivateKey.

### Method
void

### Parameters
#### Path Parameters
- **key** (ECPrivateKey) - Required - The Elliptic Curve Private Key to initialize the engine with.

### Request Example
```dart
// Assuming 'myPrivateKey' is an instance of ECPrivateKey
engine.init(myPrivateKey);
```

### Response
#### Success Response (void)
This method does not return a value.

### Implementation
```dart
@override
void init(ECPrivateKey key) {
  this.key = key;
}
```
```

--------------------------------

### Get fieldSize Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECCurve/fieldSize.html

This getter returns the size of the field. No specific setup is required beyond the class definition.

```dart
int get fieldSize;
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.keccak/KeccakDigest/init.html

Initializes the PointyCastle sponge with a specified bit length.

```APIDOC
## void init(int bitlen)

### Description
Initializes the PointyCastle sponge with a specified bit length. This method configures the internal state of the sponge based on the provided bit length.

### Method
void

### Parameters
#### Path Parameters
- **bitlen** (int) - Required - The desired bit length for the sponge initialization.
```

--------------------------------

### Mac Constructors

Source: https://pub.dev/documentation/pointycastle/latest/api/Mac-class.html

Details on how to create a Mac instance.

```APIDOC
## Constructors

### Mac(String algorithmName)

Create the MAC specified by the standard `algorithmName`.
```

--------------------------------

### Get Algorithm Name (MD2)

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.md2/MD2Digest/algorithmName.html

Returns the standard name of the algorithm. This specific example shows the name for the MD2 algorithm.

```dart
@override
String get algorithmName => 'MD2';
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.shake/SHAKEDigest/init.html

Initializes the sponge construction with a specified bit length.

```APIDOC
## init method

### Description
Initializes the sponge construction with a specified bit length. This method internally calls `_initSponge` with a calculated value based on the provided bit length.

### Method
void

### Parameters
#### Path Parameters
- **bitlen** (int) - Required - The desired bit length for the initialization.

### Request Example
```dart
init(1600);
```

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
N/A
```

--------------------------------

### Get Algorithm Name - Dart

Source: https://pub.dev/documentation/pointycastle/latest/key_derivators_argon2_native_int_impl/Argon2BytesGenerator/algorithmName.html

Override this getter to provide the standard name of the algorithm. Example shows retrieving the name 'Argon2'.

```dart
@override
String get algorithmName => 'Argon2';
```

--------------------------------

### Initialize valueStartPosition

Source: https://pub.dev/documentation/pointycastle/latest/asn1_asn1_object/ASN1Object/valueStartPosition.html

Sets the starting position for value bytes. The default is 2, but this can be affected by length bytes.

```csharp
int valueStartPosition = 2;
```

--------------------------------

### Instantiate Signer using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Examples of instantiating signature algorithms using the registry, combining a digest with ECDSA or RSA. Specific initialization parameters depend on the chosen algorithm.

```javascript
Signer('SomeDigestHere/(DET-)ECDSA')
```

```javascript
Signer('SomeDigestHere/RSA')
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.signer.rsa_signer/RSASigner/algorithmName.html

Returns the standard name of the algorithm, typically in the format 'digest/keyType'. No setup is required beyond the class implementation.

```dart
@override
String get algorithmName => '${_digest.algorithmName}/RSA';
```

--------------------------------

### Get isInfinity Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECPoint/isInfinity.html

Use this getter to determine if a value is infinite. No specific setup or imports are required beyond the context where this property is defined.

```dart
bool get isInfinity;
```

--------------------------------

### init abstract method

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECEncryptor/init.html

Initializes the encryptor with the provided cipher parameters.

```APIDOC
## void init(CipherParameters params)

### Description
Initializes the encryptor with the provided cipher parameters.

### Method
Abstract Method

### Parameters
#### Path Parameters
- **params** (CipherParameters) - Required - The cipher parameters for initialization.

### Request Example
```dart
// Example usage (assuming CipherParameters is defined elsewhere)
// encryptor.init(someCipherParameters);
```

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
```dart
// No response body for void methods
```
```

--------------------------------

### Initialize Pbkdf2Parameters

Source: https://pub.dev/documentation/pointycastle/latest/api.key_derivators/Pbkdf2Parameters/Pbkdf2Parameters.html

Use this constructor to create an instance of Pbkdf2Parameters. It requires a salt (Uint8List), the number of iterations, and the desired length of the key.

```dart
Pbkdf2Parameters(this.salt, this.iterationCount, this.desiredKeyLength);
```

--------------------------------

### Get isCompressed Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECPoint/isCompressed.html

Retrieve the boolean value indicating if the data is compressed. No specific setup is required beyond having an instance of the relevant class.

```dart
bool get isCompressed;
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/key_derivators_pkcs5s1_parameter_generator/PKCS5S1ParameterGenerator/init.html

Initializes the cryptographic parameters with the provided password, salt, and iteration count.

```APIDOC
## init method

### Description
Initializes the cryptographic parameters with the provided password, salt, and iteration count.

### Method
N/A (This is a method implementation, not an API endpoint)

### Parameters
- **password** (Uint8List) - Required - The password to be used for initialization.
- **salt** (Uint8List) - Required - The salt to be used for initialization.
- **iterationCount** (int) - Required - The number of iterations for the key derivation function.

### Request Example
```dart
// Example usage within a Dart class
init(Uint8List password, Uint8List salt, int iterationCount) {
  this.password = password;
  this.salt = salt;
  this.iterationCount = iterationCount;
}
```

### Response
N/A (This method modifies internal state and does not return a value.)
```

--------------------------------

### Get Digest Buffer Size

Source: https://pub.dev/documentation/pointycastle/latest/api/Digest/byteLength.html

Use this property to determine the byte size of the internal buffer for a digest's compression function. No setup is required.

```dart
int get byteLength;
```

--------------------------------

### Instantiate Digest using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Example of instantiating a digest algorithm like Keccak with a specific output size using the registry. Digests do not require initialization.

```javascript
Digest('Keccak/384')
```

--------------------------------

### Create ASN1ObjectIdentifier from Name

Source: https://pub.dev/documentation/pointycastle/latest/asn1_primitives_asn1_object_identifier/ASN1ObjectIdentifier/ASN1ObjectIdentifier.fromIdentifierString.html

Use this example to create an ASN1ObjectIdentifier from its common name string. This is a usage example for the constructor.

```dart
var oi = ASN1ObjectIdentifier.fromName('2.5.4.3');
```

--------------------------------

### Get Derivator Key Output Size - Dart

Source: https://pub.dev/documentation/pointycastle/latest/api/KeyDerivator/keySize.html

Use the keySize property to get the output size of a derivator key. This property is read-only.

```dart
int get keySize;
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.asymmetric.ecc.elgamal/ECElGamalDecryptor/init.html

Initializes the decryptor with provided CipherParameters. It expects AsymmetricKeyParameter with an ECAsymmetricKey, specifically an ECPrivateKey.

```APIDOC
## init method

### Description
Initializes the decryptor with provided CipherParameters. It expects AsymmetricKeyParameter with an ECAsymmetricKey, specifically an ECPrivateKey.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **params** (CipherParameters) - Required - The asymmetric key parameters for initialization.

### Request Example
```json
{
  "params": "CipherParameters object"
}
```

### Response
#### Success Response (200)
None (initialization is a void operation).

#### Response Example
None
```

--------------------------------

### Instantiate and Initialize Algorithm

Source: https://pub.dev/documentation/pointycastle/latest/index.html

General pattern for instantiating an algorithm and initializing it with its relevant parameters. Ensure to consult API docs for specific parameter classes.

```javascript
var algorithmVar = /* instantiate algorithm using registry here */ ;
var parameter = /* instantiate relevant parameter class here */ ;
algorithmVar.init(parameter);
```

--------------------------------

### Get Public Exponent (e)

Source: https://pub.dev/documentation/pointycastle/latest/api.asymmetric/RSAPublicKey/e.html

Retrieves the public exponent 'e' of the RSA key. This getter is deprecated and users should use `get publicExponent` instead.

```APIDOC
## GET /websites/pub_dev_pointycastle/e

### Description
Retrieves the public exponent 'e' of the RSA key. This getter is deprecated and users should use `get publicExponent` instead.

### Method
GET

### Endpoint
/websites/pub_dev_pointycastle/e

### Parameters
This endpoint does not accept any parameters.

### Request Example
```
GET /websites/pub_dev_pointycastle/e
```

### Response
#### Success Response (200)
- **e** (BigInt?) - The public exponent, or null if not available.

#### Response Example
```json
{
  "e": "65537"
}
```

### Deprecation Note
This getter is deprecated. Use `get publicExponent` for current implementations.
```

--------------------------------

### Instantiate Register64

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha384/SHA384Digest/h1.html

Demonstrates how to create an instance of the Register64 class. No specific setup is required beyond importing the class.

```dart
final h1 = Register64();
```

--------------------------------

### Get Derivator Key Output Size

Source: https://pub.dev/documentation/pointycastle/latest/impl.key_derivator.scrypt/Scrypt/keySize.html

Use this property to get the desired key length from the derivator's parameters. It is an override of a base class property.

```dart
@override
int get keySize => _params!.desiredKeyLength;
```

--------------------------------

### processBytes Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.sic/SICStreamCipher/processBytes.html

Processes a block of data. It takes input bytes from `inp` starting at `inpOff` for `len` bytes, and writes the processed output to `out` starting at `outOff`.

```APIDOC
## processBytes Method

### Description
Processes `len` bytes of data given by `inp` and starting at offset `inpOff`. The resulting cipher text is put in `out` beginning at position `outOff`.

### Method
`void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

### Implementation
```dart
@override
void processBytes(
    Uint8List? inp, int inpOff, int len, Uint8List? out, int outOff) {
  for (var i = 0; i < len; i++) {
    out![outOff + i] = returnByte(inp![inpOff + i]);
  }
}
```
```

--------------------------------

### Instantiate Password-Based Key Derivator using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Examples of instantiating password-based key derivators like PBKDF2, scrypt, or Argon2 using the registry. Initialization requires specific parameter objects.

```javascript
KeyDerivator('SomeDigestHere/HMAC/PBKDF2')
```

```javascript
KeyDerivator('scrypt/argon2')
```

--------------------------------

### init abstract method

Source: https://pub.dev/documentation/pointycastle/latest/api/PBEParametersGenerator/init.html

Initializes an abstract method with password, salt, and iteration count.

```APIDOC
## init abstract method

### Description
Initializes an abstract method with the provided password, salt, and iteration count.

### Method
Not applicable (abstract method definition)

### Endpoint
Not applicable (abstract method definition)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## Implementation
```dart
void init(Uint8List password, Uint8List salt, int iterationCount);
```
```

--------------------------------

### Implement processBytes Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.sic/SICStreamCipher/processBytes.html

This method processes `len` bytes of data from `inp` starting at `inpOff` and writes the result to `out` starting at `outOff`. Ensure output buffer is large enough.

```dart
@override
void processBytes(
    Uint8List? inp, int inpOff, int len, Uint8List? out, int outOff) {
  for (var i = 0; i < len; i++) {
    out![outOff + i] = returnByte(inp![inpOff + i]);
  }
}
```

--------------------------------

### Calculate Value Start Position in Dart

Source: https://pub.dev/documentation/pointycastle/latest/asn1_asn1_utils/ASN1Utils/calculateValueStartPosition.html

Calculates the start position of value bytes. Returns 2 if the length byte is <= 127. Throws RangeError if encodedBytes length is < 2.

```dart
static int calculateValueStartPosition(Uint8List encodedBytes) {
  // TODO tag length can be >1
  var length = encodedBytes[1];
  if (length <= 0x7F) {
    return 2;
  } else {
    return 2 + (length & 0x7F);
  }
}
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.asymmetric.ecc.elgamal/ECElGamalEncryptor/init.html

Initializes the encryptor with the provided cipher parameters. This method is crucial for setting up the encryption or decryption process.

```APIDOC
## init method

### Description
Initializes the encryptor.

### Method
void

### Parameters
#### Request Body
- **params** (CipherParameters) - Required - The cipher parameters to initialize the encryptor with. This can be a `ParametersWithRandom` object which includes a random number generator, or a direct `AsymmetricKeyParameter`.

### Request Example
```dart
// Example assuming you have a CipherParameters object named 'myParams'
encryptor.init(myParams);
```

### Response
This method does not return a value directly, but it configures the encryptor for subsequent operations.

### Error Handling
- Throws `ArgumentError` if an `ECPublicKey` is required but not provided.
```

--------------------------------

### Get ECCurve

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDomainParameters/curve.html

Retrieves the current ECCurve object.

```APIDOC
## GET ECCurve

### Description
Retrieves the ECCurve object.

### Method
GET

### Endpoint
/websites/pub_dev_pointycastle/curve

### Response
#### Success Response (200)
- **curve** (ECCurve) - The ECCurve object.

#### Response Example
```json
{
  "curve": "[ECCurve object representation]"
}
```
```

--------------------------------

### ChaCha20Engine Constructors

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.chacha20/ChaCha20Engine-class.html

Provides information on how to instantiate the ChaCha20Engine.

```APIDOC
## ChaCha20Engine()

### Description
Initializes a new instance of the ChaCha20Engine class.

### Method
Constructor

### Endpoint
N/A

## ChaCha20Engine.fromRounds(int rounds)

### Description
Initializes a new instance of the ChaCha20Engine class with a specified number of rounds.

### Method
Constructor

### Endpoint
N/A
```

--------------------------------

### processBlock Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.block_cipher.modes.ofb/OFBBlockCipher/processBlock.html

Processes a whole block of data. The input data is taken from `inp` starting at `inpOff`, and the resulting cipher text is written to `out` starting at `outOff`. The method returns the total bytes processed, which is equivalent to the algorithm's block size.

```APIDOC
## processBlock Method

### Description
Processes a whole block of data given by `inp` and starting at offset `inpOff`. The resulting cipher text is put in `out` beginning at position `outOff`. This method returns the total bytes processed (which is the same as the block size of the algorithm).

### Method
`int processBlock(Uint8List inp, int inpOff, Uint8List out, int outOff)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **int** - The total bytes processed (block size).

#### Response Example
`blockSize` (where `blockSize` is an integer representing the block size of the algorithm)

### Implementation Details
This method internally uses an underlying cipher to process a block. It performs XOR operations between the input data and the cipher's output to produce the final cipher text. It also manages the internal state (`_ofbV`) for subsequent block processing.
```

--------------------------------

### ChaCha20Engine Constructor

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.chacha20/ChaCha20Engine/ChaCha20Engine.html

Initializes a new instance of the ChaCha20Engine class with default settings.

```APIDOC
## ChaCha20Engine()

### Description
Initializes a new instance of the ChaCha20Engine class. The default number of rounds is set to 20.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```dart
var engine = ChaCha20Engine();
```

### Response
N/A

### Implementation Details
```dart
ChaCha20Engine() {
  rounds = 20;
}
```
```

--------------------------------

### processBlock Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.padded_block_cipher.padded_block_cipher_impl/PaddedBlockCipherImpl/processBlock.html

Processes a whole block of data. The input data is read from `inp` starting at offset `inpOff`. The resulting cipher text is written to `out` starting at position `outOff`. The method returns the total bytes processed, which is equivalent to the block size of the algorithm.

```APIDOC
## processBlock Method

### Description
Processes a whole block of data given by `inp` and starting at offset `inpOff`. The resulting cipher text is put in `out` beginning at position `outOff`. This method returns the total bytes processed (which is the same as the block size of the algorithm).

### Method
N/A (This is a method signature, not an API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **int** - The total bytes processed (block size).

#### Response Example
None

### Implementation
```dart
@override
int processBlock(Uint8List inp, int inpOff, Uint8List out, int outOff) {
  return cipher.processBlock(inp, inpOff, out, outOff);
}
```
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.padding.iso7816d4/ISO7816d4Padding/init.html

Initializes the padder. Typically, paddings do not require initialization parameters.

```APIDOC
## init method

### Description
Initialises the padder. Normally, paddings don't need any init params.

### Method
`void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Init Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.padding.pkcs7/PKCS7Padding/init.html

Initializes the padder. Typically, paddings do not require initialization parameters.

```APIDOC
## init method

### Description
Initialises the padder. Normally, paddings don't need any init params.

### Method
`void`

### Parameters
#### Path Parameters
- **params** (CipherParameters?) - Optional - Initialization parameters for the cipher.

### Implementation
```dart
@override
void init([CipherParameters? params]) {
  // nothing to do.
}
```
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/api/Algorithm/algorithmName.html

Retrieves the standard name of the algorithm.

```APIDOC
## GET /algorithmName

### Description
Get this algorithm's standard name.

### Method
GET

### Endpoint
/algorithmName

### Response
#### Success Response (200)
- **algorithmName** (String) - The standard name of the algorithm.
```

--------------------------------

### initMAC Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.chacha20poly1305/ChaCha20Poly1305/initMAC.html

Initializes the MAC by processing an initial block of data with ChaCha20 and then initializing Poly1305 with a derived key.

```APIDOC
## initMAC Method

### Description
Initializes the Message Authentication Code (MAC) functionality. This involves processing an initial block of data using the ChaCha20 stream cipher and then using a portion of the resulting keystream to initialize the Poly1305 authenticator.

### Method
`void initMAC()`

### Implementation Details
1. A 64-byte `firstBlock` is created and filled with zeros.
2. `chacha20.processBytes` is called to encrypt `firstBlock`.
3. `poly1305.init` is called with a `KeyParameter` derived from the first 32 bytes of the processed `firstBlock`.
4. A `finally` block ensures that `firstBlock` is zeroed out after use to prevent memory leakage.

### Request Example
```dart
// No explicit request parameters for this method.
// Assumes chacha20 and poly1305 objects are already initialized and available in scope.
initMAC();
```

### Response
This method does not return a value. Its effect is to initialize the internal state of the MAC mechanism.
```

--------------------------------

### Get ECDomainParameters

Source: https://pub.dev/documentation/pointycastle/latest/api.key_generators/ECKeyGeneratorParameters/domainParameters.html

Retrieves the ECDomainParameters. This is a getter method for the domain parameters.

```dart
ECDomainParameters get domainParameters => _domainParameters;
```

--------------------------------

### Get Domain Name

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDomainParameters/domainName.html

Retrieves the standard name of the current domain.

```APIDOC
## GET /websites/pub_dev_pointycastle/domainName

### Description
Get this domain's standard name.

### Method
GET

### Endpoint
/websites/pub_dev_pointycastle/domainName

### Parameters
#### Query Parameters
- None

### Response
#### Success Response (200)
- **domainName** (String) - The standard name of the domain.

### Response Example
{
  "domainName": "example.com"
}
```

--------------------------------

### Instantiate Asymmetric Key Generator using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Examples of instantiating asymmetric key generators for ECDSA or RSA using the registry. Initialization requires specific key generator parameters.

```javascript
KeyDerivator('RSA')
```

--------------------------------

### Get Infinity Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECCurve/infinity.html

Retrieves the point at infinity for an ECPoint object.

```APIDOC
## GET /infinity

### Description
Retrieves the point at infinity for an ECPoint object.

### Method
GET

### Endpoint
/infinity

### Response
#### Success Response (200)
- **infinity** (ECPoint?) - The point at infinity.

#### Response Example
```json
{
  "infinity": null 
}
```
```

--------------------------------

### Get ECFieldElement Property

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECCurve/a.html

Retrieves the ECFieldElement property. This is a getter declaration.

```dart
ECFieldElement? get a;
```

--------------------------------

### Instantiate Asymmetric Block Cipher using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Example of instantiating an asymmetric block cipher like RSA with a specific encoding (e.g., PKCS1) using the registry. Initialization requires a private or public key.

```javascript
AsymmetricBlockCipher('RSA/SomeEncodingHere')
```

--------------------------------

### Instantiate Register64

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha384/SHA384Digest/h2.html

Demonstrates how to create an instance of the Register64 class. No specific setup or imports are required beyond the class definition.

```dart
final h2 = Register64();
```

--------------------------------

### Get Padding

Source: https://pub.dev/documentation/pointycastle/latest/api/PaddedBlockCipher/padding.html

Retrieves the underlying Padding object used by this cipher.

```APIDOC
## Get Padding

### Description
Get the underlying Padding used by this cipher.

### Method
GET

### Endpoint
N/A (This is a property getter, not an HTTP endpoint)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **padding** (Padding) - The underlying Padding object.

#### Response Example
```
Padding get padding;
```
```

--------------------------------

### Get Salt Property

Source: https://pub.dev/documentation/pointycastle/latest/api.key_derivators/Argon2Parameters/salt.html

Retrieves the salt value as a Uint8List. This property is read-only.

```dart
Uint8List get salt => _salt;
```

--------------------------------

### init method

Source: https://pub.dev/documentation/pointycastle/latest/block_rc2_engine/RC2Engine/init.html

Initializes the cipher with its initialization parameters and specifies whether to encrypt or decrypt.

```APIDOC
## init method

### Description
Initializes the cipher with its initialization `params`. The type of `CipherParameters` depends on the algorithm being used. Use the `forEncryption` argument to specify whether the cipher should be used for encryption or decryption.

### Method
`init`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **forEncryption** (bool) - Required - If true, the cipher will be used for encryption; if false, for decryption.
- **params** (CipherParameters?) - Optional - The initialization parameters for the cipher. The specific type depends on the algorithm.

### Request Example
```dart
// Example usage with RC2Parameters
final rc2Params = RC2Parameters(Uint8List.fromList([1, 2, 3, 4, 5]));
cipher.init(true, rc2Params);

// Example usage with KeyParameter
final keyParams = KeyParameter(Uint8List.fromList([6, 7, 8, 9, 10]));
cipher.init(false, keyParams);
```

### Response
#### Success Response (200)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### Get X Property of ECFieldElement

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECPoint/x.html

Retrieves the x-coordinate of an ECFieldElement. This is a getter method.

```dart
ECFieldElement? get x;
```

--------------------------------

### Abstract Method: init

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDecryptor/init.html

Initializes the decryptor with the provided cipher parameters.

```APIDOC
## void init(CipherParameters params)

### Description
Initializes the decryptor with the provided cipher parameters.

### Method
Abstract Method Declaration

### Endpoint
N/A (Abstract Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (N/A)
This is an abstract method declaration and does not have a direct response.

#### Response Example
None
```

--------------------------------

### Get Domain Name

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECDomainParameters/domainName.html

Retrieve the standard name of the domain. This property is a String.

```dart
String get domainName;
```

--------------------------------

### Poly1305 init method

Source: https://pub.dev/documentation/pointycastle/latest/impl.mac.poly1305/Poly1305/init.html

Initializes the MAC with its initialization parameters. The type of CipherParameters depends on the algorithm being used.

```APIDOC
## Poly1305 init method

### Description
Initializes the MAC with its initialization `params`. The type of CipherParameters depends on the algorithm being used (see the documentation of each implementation to find out more).

### Method
`init`

### Parameters
#### Request Body
- **params** (CipherParameters) - Required - The initialization parameters for the MAC.

### Request Example
```dart
// Example usage (assuming CipherParameters are correctly instantiated)
// poly1305Instance.init(someCipherParameters);
```

### Response
This method does not return a value, but it initializes the Poly1305 instance.

### Implementation Details
- If a cipher is present, `params` must be of type `ParametersWithIV`, and its `iv` will be used as the nonce.
- `params` must be of type `KeyParameter`.
- The provided key is checked and potentially clamped.
- The key and nonce (if provided) are set.
- The MAC is reset.
```

--------------------------------

### Get Public Exponent

Source: https://pub.dev/documentation/pointycastle/latest/api.asymmetric/RSAPrivateKey/publicExponent.html

Retrieves the public exponent (e) of the cryptographic key.

```APIDOC
## GET /websites/pub_dev_pointycastle/publicExponent

### Description
Retrieves the public exponent (e) of the cryptographic key.

### Method
GET

### Endpoint
/websites/pub_dev_pointycastle/publicExponent

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **publicExponent** (BigInt?) - The public exponent value.

#### Response Example
```json
{
  "publicExponent": "65537"
}
```
```

--------------------------------

### Instantiate Register64

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha384/SHA384Digest/h3.html

Demonstrates how to create an instance of the Register64 class. No specific setup or imports are required for this basic instantiation.

```dart
final h3 = Register64();
```

--------------------------------

### Get Cipher Property

Source: https://pub.dev/documentation/pointycastle/latest/api/PaddedBlockCipher/cipher.html

Retrieves the underlying BlockCipher instance associated with this cipher.

```APIDOC
## GET /cipher

### Description
Get the underlying BlockCipher used by this cipher.

### Method
GET

### Endpoint
/cipher

### Response
#### Success Response (200)
- **cipher** (BlockCipher) - The underlying BlockCipher instance.
```

--------------------------------

### Instantiate Algorithms Using the Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Use the registry to instantiate algorithms by name. This is convenient for algorithms composed of multiple classes. Ensure the necessary registry entries are available.

```dart
final sha256 = Digest("SHA-256");
final sha1 = Digest("SHA-1");
final md5 = Digest("MD5");

final hmacSha256 = Mac("SHA-256/HMAC");
final hmacSha1 = Mac("SHA-1/HMAC");
final hmacMd5 = Mac("MD5/HMAC");

final derivator = KeyDerivator("SHA-1/HMAC/PBKDF2");

final signer = Signer("SHA-256/RSA");

```

--------------------------------

### Get Argon2Parameters Property

Source: https://pub.dev/documentation/pointycastle/latest/key_derivators_argon2_native_int_impl/Argon2BytesGenerator/parameters.html

Retrieves the Argon2 parameters. This is a getter for the private _parameters field.

```dart
Argon2Parameters get parameters => _parameters;
```

--------------------------------

### ParametersWithSaltConfiguration Constructor

Source: https://pub.dev/documentation/pointycastle/latest/api/ParametersWithSaltConfiguration/ParametersWithSaltConfiguration.html

This constructor initializes a new instance of the ParametersWithSaltConfiguration class.

```APIDOC
## ParametersWithSaltConfiguration Constructor

### Description
Initializes a new instance of the ParametersWithSaltConfiguration class.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Initialization Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha3/SHA3Digest/init.html

The `init` method is used to initialize the sponge object with a specified bit length.

```APIDOC
## init method

### Description
Initializes the sponge object with a given bit length. This method internally calls `_initSponge` with a calculated value based on the provided `bitlen`.

### Method
void

### Parameters
#### Path Parameters
- **bitlen** (int) - Required - The desired bit length for initialization.
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.secure_random.fortuna_random/FortunaRandom/algorithmName.html

Returns the standard name of the algorithm. This implementation returns 'Fortuna'.

```dart
@override
String get algorithmName => 'Fortuna';
```

--------------------------------

### ASN1SubjectPublicKeyInfo Constructor

Source: https://pub.dev/documentation/pointycastle/latest/asn1_pkcs_pkcs10_asn1_subject_public_key_info/ASN1SubjectPublicKeyInfo/ASN1SubjectPublicKeyInfo.html

The ASN1SubjectPublicKeyInfo constructor initializes a new instance with the specified algorithm and subject public key.

```APIDOC
## ASN1SubjectPublicKeyInfo Constructor

### Description
Initializes a new instance of the ASN1SubjectPublicKeyInfo class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **algorithm** (ASN1AlgorithmIdentifier) - Required - The algorithm identifier.
- **subjectPublicKey** (ASN1BitString) - Required - The subject's public key.

### Request Example
```dart
ASN1SubjectPublicKeyInfo(
  algorithm,
  subjectPublicKey,
);
```

### Response
#### Success Response (200)
An instance of ASN1SubjectPublicKeyInfo.

#### Response Example
```json
{
  "algorithm": "<ASN1AlgorithmIdentifier object>",
  "subjectPublicKey": "<ASN1BitString object>"
}
```
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.padding.pkcs7/PKCS7Padding/algorithmName.html

Returns the standard name of the algorithm. This implementation returns 'PKCS7'.

```dart
@override
String get algorithmName => 'PKCS7';
```

--------------------------------

### Get fieldSize Property

Source: https://pub.dev/documentation/pointycastle/latest/impl.ecc.ecc_fp/ECCurve/fieldSize.html

Returns the bit length of the field. This is an override of the base property.

```dart
@override
int get fieldSize => q!.bitLength;
```

--------------------------------

### SRP6Server Implementation

Source: https://pub.dev/documentation/pointycastle/latest/impl.srp_server/SRP6Server/SRP6Server.html

The implementation details of the SRP6Server constructor, including the initialization of group parameters.

```APIDOC
## SRP6Server Implementation

### Description
This section shows the internal implementation of the SRP6Server constructor.

### Method
Constructor

### Endpoint
N/A (Internal Implementation)

### Parameters
None (Internal Implementation)

### Request Example
None

### Response
#### Success Response (200)
None (Internal Implementation)

#### Response Example
None
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.sha384/SHA384Digest/algorithmName.html

Returns the standard name of the algorithm. This property is final and cannot be changed.

```dart
@override
final algorithmName = 'SHA-384';
```

--------------------------------

### Salsa20Engine Constructor

Source: https://pub.dev/documentation/pointycastle/latest/impl.stream_cipher.salsa20/Salsa20Engine/Salsa20Engine.html

Initializes a new instance of the Salsa20Engine class.

```APIDOC
## Salsa20Engine()

### Description
Initializes a new instance of the Salsa20Engine class.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
Initializes a new Salsa20Engine object.

#### Response Example
```json
{
  "message": "Salsa20Engine initialized successfully"
}
```
```

--------------------------------

### Constructors

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.ripemd320/RIPEMD320Digest-class.html

Details on how to create an instance of the RIPEMD320Digest class.

```APIDOC
## Constructors

### RIPEMD320Digest()

Creates a new instance of the RIPEMD320Digest class.
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.ripemd256/RIPEMD256Digest/algorithmName.html

Returns the standard name of the algorithm. This property is final and should not be modified.

```dart
@override
final algorithmName = 'RIPEMD-256';
```

--------------------------------

### Init Method for Password-Based Key Derivation

Source: https://pub.dev/documentation/pointycastle/latest/key_derivators_pkcs12_parameter_generator/PKCS12ParametersGenerator/init.html

Initializes the cryptographic context with user-provided password, salt, and iteration count for secure key derivation.

```APIDOC
## init method

### Description
Initializes the cryptographic context with a password, salt, and iteration count. This is typically used for password-based key derivation functions (PBKDF).

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **password** (Uint8List) - Required - The user's password as a byte array.
- **salt** (Uint8List) - Required - A random byte array used to protect against precomputed rainbow table attacks.
- **iterationCount** (int) - Required - The number of iterations to perform for key derivation, increasing security against brute-force attacks.

### Request Example
```dart
// Assuming password, salt, and iterationCount are defined elsewhere
init(password, salt, iterationCount);
```

### Response
This method does not return a value directly but initializes internal state.

#### Success Response (void)
N/A

#### Response Example
N/A
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.digest.md4/MD4Digest/algorithmName.html

Returns the standard name of the algorithm. This property is final and should not be overridden.

```dart
@override
final algorithmName = 'MD4';
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.block_cipher.twofish/TwofishEngine/algorithmName.html

Returns the standard name of the algorithm. This implementation specifies 'Twofish'.

```dart
@override
String get algorithmName => 'Twofish';
```

--------------------------------

### Abstract MAC Initialization

Source: https://pub.dev/documentation/pointycastle/latest/api/Mac/init.html

The `init` method is an abstract method used to initialize a MAC algorithm with specific CipherParameters. The exact type of CipherParameters required depends on the MAC algorithm being implemented.

```APIDOC
## void init(CipherParameters params)

### Description
Initializes the MAC with its initialization `params`. The type of CipherParameters depends on the algorithm being used. Refer to the documentation of each specific implementation for details.

### Method
void

### Endpoint
N/A (Abstract Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (void)
This method does not return a value.

#### Response Example
None
```

--------------------------------

### HKDF Initialization Method

Source: https://pub.dev/documentation/pointycastle/latest/impl.key_derivator.hkdf/HKDFKeyDerivator/init.html

The `init` method initializes the HKDF derivator with the provided `HkdfParameters`. It handles the extraction of the pseudorandom key (PRK) based on whether extraction is skipped.

```APIDOC
## void init(HkdfParameters params)

### Description
Initializes the HKDF derivator with its initialization parameters. The type of `CipherParameters` depends on the algorithm being used.

### Method
`init`

### Parameters
#### Request Body
- **params** (HkdfParameters) - Required - The initialization parameters for HKDF.
  - **ikm** (Uint8List) - Required - Input Key Material.
  - **salt** (Uint8List) - Optional - The salt value.
  - **info** (Uint8List) - Optional - Context and application specific information.
  - **skipExtract** (bool) - Optional - If true, the IKM is used directly as PRK.

### Request Example
```json
{
  "ikm": "...",
  "salt": "...",
  "info": "...",
  "skipExtract": false
}
```

### Response
#### Success Response (200)
This method does not return a value, it initializes the internal state of the derivator.

#### Response Example
(No response body for initialization)

### Implementation Details
```dart
@override
void init(covariant HkdfParameters params) {
  _params = params;

  if (_params.skipExtract) {
    // use IKM directly as PRK
    _hMac.init(KeyParameter(_params.ikm));
  } else {
    _hMac.init(extract(_params.salt, _params.ikm));
  }

  _info = _params.info;

  _generatedBytes = 0;
  _currentT = Uint8List(_hashLen);
}
```
```

--------------------------------

### BlockCipher get underlyingCipher

Source: https://pub.dev/documentation/pointycastle/latest/impl.block_cipher.modes.gcm/GCMBlockCipher/underlyingCipher.html

Retrieves the underlying cipher used by the BlockCipher. This property is inherited.

```APIDOC
## BlockCipher get underlyingCipher

### Description
Returns the underlying cipher.

### Method
GET

### Endpoint
N/A (Property Access)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **underlyingCipher** (BlockCipher) - The underlying cipher instance.

### Response Example
```dart
// Assuming 'cipher' is an instance of BlockCipher
var underlying = cipher.underlyingCipher;
```
```

--------------------------------

### Instantiate Block Cipher using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Demonstrates instantiating a block cipher using the registry, specifying the cipher, mode, and padding. Block ciphers can also be used in stream cipher modes.

```javascript
PaddedBlockCipher('AES/SomeBlockModeHere/SomePaddingHere')
```

```javascript
StreamCipher('AES/SomeStreamModeHere')
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.block_cipher.aes_fast/AESFastEngine/algorithmName.html

Returns the standard name of the algorithm. This is an override of the base getter.

```dart
@override
String get algorithmName => 'AES_FAST_';
```

--------------------------------

### Get Algorithm Name

Source: https://pub.dev/documentation/pointycastle/latest/impl.block_cipher.aes/AESEngine/algorithmName.html

Returns the standard name of the algorithm. This implementation returns 'AES'.

```dart
@override
String get algorithmName => 'AES';
```

--------------------------------

### Instantiate Stream Cipher using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Example of instantiating a stream cipher like 'ChaCha20' with a specified number of rounds using the registry. Initialization requires ParametersWithIV.

```javascript
StreamCipher('ChaCha20/20')
```

--------------------------------

### Instantiate HMAC-Based Key Derivator using Registry

Source: https://pub.dev/documentation/pointycastle/latest/index.html

Example of instantiating an HMAC-based key derivator like HKDF using the registry. Initialization requires HkdfParameters.

```javascript
KeyDerivator('SomeDigestHere/HKDF')
```

--------------------------------

### Additional Property Getter

Source: https://pub.dev/documentation/pointycastle/latest/api.key_derivators/Argon2Parameters/additional.html

This snippet shows how to get the additional property, which is of type Uint8List?.

```APIDOC
## GET /websites/pub_dev_pointycastle/additional

### Description
Retrieves the additional property associated with the project.

### Method
GET

### Endpoint
/websites/pub_dev_pointycastle/additional

### Response
#### Success Response (200)
- **additional** (Uint8List?) - The additional property value.
```

--------------------------------

### ParametersWithSaltConfiguration Class Overview

Source: https://pub.dev/documentation/pointycastle/latest/api/ParametersWithSaltConfiguration-class.html

Provides details on the ParametersWithSaltConfiguration class, its purpose, and its implementation.

```APIDOC
## ParametersWithSaltConfiguration<UnderlyingParameters extends CipherParameters> class

CipherParameters consisting of an underlying CipherParameters (of type `UnderlyingParameters`), an accompanying SecureRandom, and salt length.

Implemented types:
* CipherParameters

### Constructors

ParametersWithSaltConfiguration(UnderlyingParameters parameters, SecureRandom random, int saltLength)

### Properties

- **parameters** (UnderlyingParameters) - final
- **random** (SecureRandom) - final
- **saltLength** (int) - final

### Methods

- **hashCode** → int - The hash code for this object.
- **runtimeType** → Type - A representation of the runtime type of the object.
- **noSuchMethod**(Invocation invocation) → dynamic - Invoked when a nonexistent method or property is accessed.
- **toString**() → String - A string representation of this object.

### Operators

- **operator ==**(Object other) → bool - The equality operator.
```

--------------------------------

### Get Y Property of ECFieldElement

Source: https://pub.dev/documentation/pointycastle/latest/api.ecc/ECPoint/y.html

Retrieves the y-coordinate of an ECFieldElement. This property is part of the ECFieldElement interface.

```dart
ECFieldElement? get y;
```
Tokens:
Raw