diff options
Diffstat (limited to 'doc/api/crypto.md')
| -rw-r--r-- | doc/api/crypto.md | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index f90c2cfe2e..ac14ab8499 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -270,7 +270,7 @@ been completed using the [`cipher.final()`][] method. <!-- YAML added: v0.7.1 --> -- `autoPadding` {boolean} Defaults to `true`. +- `autoPadding` {boolean} **Default:** `true` - Returns the {Cipher} for method chaining. When using block encryption algorithms, the `Cipher` class will automatically @@ -443,7 +443,7 @@ The `decipher.setAuthTag()` method must be called before <!-- YAML added: v0.7.1 --> -- `autoPadding` {boolean} Defaults to `true`. +- `autoPadding` {boolean} **Default:** `true` - Returns the {Cipher} for method chaining. When data has been encrypted without standard block padding, calling @@ -665,7 +665,7 @@ added: REPLACEME - `curve` {string} - `inputEncoding` {string} - `outputEncoding` {string} -- `format` {string} Defaults to `uncompressed`. +- `format` {string} **Default:** `uncompressed` Converts the EC Diffie-Hellman public key specified by `key` and `curve` to the format specified by `format`. The `format` argument specifies point encoding @@ -742,7 +742,7 @@ its recommended for developers to handle this exception accordingly. added: v0.11.14 --> - `encoding` {string} -- `format` {string} Defaults to `uncompressed`. +- `format` {string} **Default:** `uncompressed` Generates private and public EC Diffie-Hellman key values, and returns the public key in the specified `format` and `encoding`. This key should be @@ -771,7 +771,7 @@ a string is returned; otherwise a [`Buffer`][] is returned. added: v0.11.14 --> - `encoding` {string} -- `format` {string} Defaults to `uncompressed`. +- `format` {string} **Default:** `uncompressed` Returns the EC Diffie-Hellman public key in the specified `encoding` and `format`. @@ -1454,8 +1454,8 @@ changes: --> - `prime` {string | Buffer | TypedArray | DataView} - `primeEncoding` {string} -- `generator` {number | string | Buffer | TypedArray | DataView} Defaults to - `2`. +- `generator` {number | string | Buffer | TypedArray | DataView} **Default:** + `2` - `generatorEncoding` {string} Creates a `DiffieHellman` key exchange object using the supplied `prime` and an @@ -1478,8 +1478,8 @@ otherwise a number, [`Buffer`][], `TypedArray`, or `DataView` is expected. added: v0.5.0 --> - `primeLength` {number} -- `generator` {number | string | Buffer | TypedArray | DataView} Defaults to - `2`. +- `generator` {number | string | Buffer | TypedArray | DataView} **Default:** + `2` Creates a `DiffieHellman` key exchange object and generates a prime of `primeLength` bits using an optional specific numeric `generator`. @@ -1957,8 +1957,8 @@ changes: --> * `buffer` {Buffer|TypedArray|DataView} Must be supplied. -* `offset` {number} Defaults to `0`. -* `size` {number} Defaults to `buffer.length - offset`. +* `offset` {number} **Default:** `0` +* `size` {number} **Default:** `buffer.length - offset` Synchronous version of [`crypto.randomFill()`][]. @@ -1999,8 +1999,8 @@ changes: --> * `buffer` {Buffer|TypedArray|DataView} Must be supplied. -* `offset` {number} Defaults to `0`. -* `size` {number} Defaults to `buffer.length - offset`. +* `offset` {number} **Default:** `0` +* `size` {number} **Default:** `buffer.length - offset` * `callback` {Function} `function(err, buf) {}`. This function is similar to [`crypto.randomBytes()`][] but requires the first @@ -2064,7 +2064,7 @@ request. added: v0.11.11 --> - `engine` {string} -- `flags` {crypto.constants} Defaults to `crypto.constants.ENGINE_METHOD_ALL`. +- `flags` {crypto.constants} **Default:** `crypto.constants.ENGINE_METHOD_ALL` Load and set the `engine` for some or all OpenSSL functions (selected by flags). |