{ "source": "doc/api/crypto.markdown", "modules": [ { "textRaw": "Crypto", "name": "crypto", "desc": "
Stability: 2 - Unstable; API changes are being discussed for\nfuture versions. Breaking changes will be minimized. See below.
\nUse require('crypto')
to access this module.\n\n
The crypto module offers a way of encapsulating secure credentials to be\nused as part of a secure HTTPS net or http connection.\n\n
\nIt also offers a set of wrappers for OpenSSL's hash, hmac, cipher,\ndecipher, sign and verify methods.\n\n\n
\n", "methods": [ { "textRaw": "crypto.setEngine(engine[, flags])", "type": "method", "name": "setEngine", "desc": "Load and set engine for some/all OpenSSL functions (selected by flags).\n\n
\nengine
could be either an id or a path to the to the engine's shared library.\n\n
flags
is optional and has ENGINE_METHOD_ALL
value by default. It could take\none of or mix of following flags (defined in constants
module):\n\n
ENGINE_METHOD_RSA
ENGINE_METHOD_DSA
ENGINE_METHOD_DH
ENGINE_METHOD_RAND
ENGINE_METHOD_ECDH
ENGINE_METHOD_ECDSA
ENGINE_METHOD_CIPHERS
ENGINE_METHOD_DIGESTS
ENGINE_METHOD_STORE
ENGINE_METHOD_PKEY_METH
ENGINE_METHOD_PKEY_ASN1_METH
ENGINE_METHOD_ALL
ENGINE_METHOD_NONE
Returns an array with the names of the supported ciphers.\n\n
\nExample:\n\n
\nvar ciphers = crypto.getCiphers();\nconsole.log(ciphers); // ['AES-128-CBC', 'AES-128-CBC-HMAC-SHA1', ...]
\n",
"signatures": [
{
"params": []
}
]
},
{
"textRaw": "crypto.getHashes()",
"type": "method",
"name": "getHashes",
"desc": "Returns an array with the names of the supported hash algorithms.\n\n
\nExample:\n\n
\nvar hashes = crypto.getHashes();\nconsole.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]
\n",
"signatures": [
{
"params": []
}
]
},
{
"textRaw": "crypto.createCredentials(details)",
"type": "method",
"name": "createCredentials",
"stability": 0,
"stabilityText": "Deprecated. Use [tls.createSecureContext][] instead.",
"desc": "Creates a credentials object, with the optional details being a\ndictionary with keys:\n\n
\npfx
: A string or buffer holding the PFX or PKCS12 encoded private\nkey, certificate and CA certificateskey
: A string holding the PEM encoded private keypassphrase
: A string of passphrase for the private key or pfxcert
: A string holding the PEM encoded certificateca
: Either a string or list of strings of PEM encoded CA\ncertificates to trust.crl
: Either a string or list of strings of PEM encoded CRLs\n(Certificate Revocation List)ciphers
: A string describing the ciphers to use or exclude.\nConsult\nhttp://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT\nfor details on the format.If no 'ca' details are given, then node.js will use the default\npublicly trusted list of CAs as given in\n
\nhttp://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt.\n\n\n
\n", "signatures": [ { "params": [ { "name": "details" } ] } ] }, { "textRaw": "crypto.createHash(algorithm)", "type": "method", "name": "createHash", "desc": "Creates and returns a hash object, a cryptographic hash with the given\nalgorithm which can be used to generate hash digests.\n\n
\nalgorithm
is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are 'sha1'
, 'md5'
,\n'sha256'
, 'sha512'
, etc. On recent releases, openssl\nlist-message-digest-algorithms
will display the available digest\nalgorithms.\n\n
Example: this program that takes the sha1 sum of a file\n\n
\nvar filename = process.argv[2];\nvar crypto = require('crypto');\nvar fs = require('fs');\n\nvar shasum = crypto.createHash('sha1');\n\nvar s = fs.ReadStream(filename);\ns.on('data', function(d) {\n shasum.update(d);\n});\n\ns.on('end', function() {\n var d = shasum.digest('hex');\n console.log(d + ' ' + filename);\n});
\n",
"signatures": [
{
"params": [
{
"name": "algorithm"
}
]
}
]
},
{
"textRaw": "crypto.createHmac(algorithm, key)",
"type": "method",
"name": "createHmac",
"desc": "Creates and returns a hmac object, a cryptographic hmac with the given\nalgorithm and key.\n\n
\nIt is a stream that is both readable and writable. The\nwritten data is used to compute the hmac. Once the writable side of\nthe stream is ended, use the read()
method to get the computed\ndigest. The legacy update
and digest
methods are also supported.\n\n
algorithm
is dependent on the available algorithms supported by\nOpenSSL - see createHash above. key
is the hmac key to be used.\n\n
Creates and returns a cipher object, with the given algorithm and\npassword.\n\n
\nalgorithm
is dependent on OpenSSL, examples are 'aes192'
, etc. On\nrecent releases, openssl list-cipher-algorithms
will display the\navailable cipher algorithms. password
is used to derive key and IV,\nwhich must be a 'binary'
encoded string or a buffer.\n\n
It is a stream that is both readable and writable. The\nwritten data is used to compute the hash. Once the writable side of\nthe stream is ended, use the read()
method to get the enciphered\ncontents. The legacy update
and final
methods are also supported.\n\n
Note: createCipher
derives keys with the OpenSSL function [EVP_BytesToKey][]\nwith the digest algorithm set to MD5, one iteration, and no salt. The lack of\nsalt allows dictionary attacks as the same password always creates the same key.\nThe low iteration count and non-cryptographically secure hash algorithm allow\npasswords to be tested very rapidly.\n\n
In line with OpenSSL's recommendation to use pbkdf2 instead of EVP_BytesToKey it\nis recommended you derive a key and iv yourself with [crypto.pbkdf2][] and to\nthen use [createCipheriv()][] to create the cipher stream.\n\n
\n", "signatures": [ { "params": [ { "name": "algorithm" }, { "name": "password" } ] } ] }, { "textRaw": "crypto.createCipheriv(algorithm, key, iv)", "type": "method", "name": "createCipheriv", "desc": "Creates and returns a cipher object, with the given algorithm, key and\niv.\n\n
\nalgorithm
is the same as the argument to createCipher()
. key
is\nthe raw key used by the algorithm. iv
is an initialization\nvector.\n\n
key
and iv
must be 'binary'
encoded strings or\nbuffers.\n\n
Creates and returns a decipher object, with the given algorithm and\nkey. This is the mirror of the [createCipher()][] above.\n\n
\n", "signatures": [ { "params": [ { "name": "algorithm" }, { "name": "password" } ] } ] }, { "textRaw": "crypto.createDecipheriv(algorithm, key, iv)", "type": "method", "name": "createDecipheriv", "desc": "Creates and returns a decipher object, with the given algorithm, key\nand iv. This is the mirror of the [createCipheriv()][] above.\n\n
\n", "signatures": [ { "params": [ { "name": "algorithm" }, { "name": "key" }, { "name": "iv" } ] } ] }, { "textRaw": "crypto.createSign(algorithm)", "type": "method", "name": "createSign", "desc": "Creates and returns a signing object, with the given algorithm. On\nrecent OpenSSL releases, openssl list-public-key-algorithms
will\ndisplay the available signing algorithms. Examples are 'RSA-SHA256'
.\n\n
Creates and returns a verification object, with the given algorithm.\nThis is the mirror of the signing object above.\n\n
\n", "signatures": [ { "params": [ { "name": "algorithm" } ] } ] }, { "textRaw": "crypto.createDiffieHellman(prime_length[, generator])", "type": "method", "name": "createDiffieHellman", "desc": "Creates a Diffie-Hellman key exchange object and generates a prime of\nprime_length
bits and using an optional specific numeric generator
.\nIf no generator
is specified, then 2
is used.\n\n
Creates a Diffie-Hellman key exchange object using the supplied prime
and an\noptional specific generator
.\ngenerator
can be a number, string, or Buffer.\nIf no generator
is specified, then 2
is used.\nprime_encoding
and generator_encoding
can be 'binary'
, 'hex'
, or 'base64'
.\nIf no prime_encoding
is specified, then a Buffer is expected for prime
.\nIf no generator_encoding
is specified, then a Buffer is expected for generator
.\n\n
Creates a predefined Diffie-Hellman key exchange object. The\nsupported groups are: 'modp1'
, 'modp2'
, 'modp5'
(defined in [RFC\n2412][]) and 'modp14'
, 'modp15'
, 'modp16'
, 'modp17'
,\n'modp18'
(defined in [RFC 3526][]). The returned object mimics the\ninterface of objects created by [crypto.createDiffieHellman()][]\nabove, but will not allow to change the keys (with\n[diffieHellman.setPublicKey()][] for example). The advantage of using\nthis routine is that the parties don't have to generate nor exchange\ngroup modulus beforehand, saving both processor and communication\ntime.\n\n
Example (obtaining a shared secret):\n\n
\nvar crypto = require('crypto');\nvar alice = crypto.getDiffieHellman('modp5');\nvar bob = crypto.getDiffieHellman('modp5');\n\nalice.generateKeys();\nbob.generateKeys();\n\nvar alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nvar bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* alice_secret and bob_secret should be the same */\nconsole.log(alice_secret == bob_secret);
\n",
"signatures": [
{
"params": [
{
"name": "group_name"
}
]
}
]
},
{
"textRaw": "crypto.createECDH(curve_name)",
"type": "method",
"name": "createECDH",
"desc": "Creates an Elliptic Curve (EC) Diffie-Hellman key exchange object using a\npredefined curve specified by curve_name
string.\n\n
Asynchronous PBKDF2 function. Applies the selected HMAC digest function\n(default: SHA1) to derive a key of the requested length from the password,\nsalt and number of iterations. The callback gets two arguments:\n(err, derivedKey)
.\n\n
Example:\n\n
\ncrypto.pbkdf2('secret', 'salt', 4096, 512, 'sha256', function(err, key) {\n if (err)\n throw err;\n console.log(key.toString('hex')); // 'c5e478d...1469e50'\n});
\nYou can get a list of supported digest functions with\ncrypto.getHashes().\n\n
\n", "signatures": [ { "params": [ { "name": "password" }, { "name": "salt" }, { "name": "iterations" }, { "name": "keylen" }, { "name": "digest", "optional": true }, { "name": "callback" } ] } ] }, { "textRaw": "crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])", "type": "method", "name": "pbkdf2Sync", "desc": "Synchronous PBKDF2 function. Returns derivedKey or throws error.\n\n
\n", "signatures": [ { "params": [ { "name": "password" }, { "name": "salt" }, { "name": "iterations" }, { "name": "keylen" }, { "name": "digest", "optional": true } ] } ] }, { "textRaw": "crypto.randomBytes(size[, callback])", "type": "method", "name": "randomBytes", "desc": "Generates cryptographically strong pseudo-random data. Usage:\n\n
\n// async\ncrypto.randomBytes(256, function(ex, buf) {\n if (ex) throw ex;\n console.log('Have %d bytes of random data: %s', buf.length, buf);\n});\n\n// sync\ntry {\n var buf = crypto.randomBytes(256);\n console.log('Have %d bytes of random data: %s', buf.length, buf);\n} catch (ex) {\n // handle error\n // most likely, entropy sources are drained\n}
\nNOTE: Will throw error or invoke callback with error, if there is not enough\naccumulated entropy to generate cryptographically strong data. In other words,\ncrypto.randomBytes
without callback will not block even if all entropy sources\nare drained.\n\n
Generates non-cryptographically strong pseudo-random data. The data\nreturned will be unique if it is sufficiently long, but is not\nnecessarily unpredictable. For this reason, the output of this\nfunction should never be used where unpredictability is important,\nsuch as in the generation of encryption keys.\n\n
\nUsage is otherwise identical to crypto.randomBytes
.\n\n
Encrypts buffer
with public_key
. Only RSA is currently supported.\n\n
public_key
can be an object or a string. If public_key
is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING
.\n\n
public_key
:\n\n
key
: A string holding the PEM encoded private keypadding
: An optional padding value, one of the following:constants.RSA_NO_PADDING
constants.RSA_PKCS1_PADDING
constants.RSA_PKCS1_OAEP_PADDING
NOTE: All paddings are defined in constants
module.\n\n
Decrypts buffer
with private_key
.\n\n
private_key
can be an object or a string. If private_key
is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING
.\n\n
private_key
:\n\n
key
: A string holding the PEM encoded private keypassphrase
: An optional string of passphrase for the private keypadding
: An optional padding value, one of the following:constants.RSA_NO_PADDING
constants.RSA_PKCS1_PADDING
constants.RSA_PKCS1_OAEP_PADDING
NOTE: All paddings are defined in constants
module.\n\n
The class for creating hash digests of data.\n\n
\nIt is a stream that is both readable and writable. The\nwritten data is used to compute the hash. Once the writable side of\nthe stream is ended, use the read()
method to get the computed hash\ndigest. The legacy update
and digest
methods are also supported.\n\n
Returned by crypto.createHash
.\n\n
Updates the hash content with the given data
, the encoding of which\nis given in input_encoding
and can be 'utf8'
, 'ascii'
or\n'binary'
. If no encoding is provided and the input is a string an\nencoding of 'binary'
is enforced. If data
is a Buffer
then\ninput_encoding
is ignored.\n\n
This can be called many times with new data as it is streamed.\n\n
\n", "signatures": [ { "params": [ { "name": "data" }, { "name": "input_encoding", "optional": true } ] } ] }, { "textRaw": "hash.digest([encoding])", "type": "method", "name": "digest", "desc": "Calculates the digest of all of the passed data to be hashed. The\nencoding
can be 'hex'
, 'binary'
or 'base64'
. If no encoding\nis provided, then a buffer is returned.\n\n
Note: hash
object can not be used after digest()
method has been\ncalled.\n\n\n
Class for creating cryptographic hmac content.\n\n
\nReturned by crypto.createHmac
.\n\n
Update the hmac content with the given data
. This can be called\nmany times with new data as it is streamed.\n\n
Calculates the digest of all of the passed data to the hmac. The\nencoding
can be 'hex'
, 'binary'
or 'base64'
. If no encoding\nis provided, then a buffer is returned.\n\n
Note: hmac
object can not be used after digest()
method has been\ncalled.\n\n\n
Class for encrypting data.\n\n
\nReturned by crypto.createCipher
and crypto.createCipheriv
.\n\n
Cipher objects are streams that are both readable and\nwritable. The written plain text data is used to produce the\nencrypted data on the readable side. The legacy update
and final
\nmethods are also supported.\n\n
Updates the cipher with data
, the encoding of which is given in\ninput_encoding
and can be 'utf8'
, 'ascii'
or 'binary'
. If no\nencoding is provided, then a buffer is expected.\nIf data
is a Buffer
then input_encoding
is ignored.\n\n
The output_encoding
specifies the output format of the enciphered\ndata, and can be 'binary'
, 'base64'
or 'hex'
. If no encoding is\nprovided, then a buffer is returned.\n\n
Returns the enciphered contents, and can be called many times with new\ndata as it is streamed.\n\n
\n", "signatures": [ { "params": [ { "name": "data" }, { "name": "input_encoding", "optional": true }, { "name": "output_encoding", "optional": true } ] } ] }, { "textRaw": "cipher.final([output_encoding])", "type": "method", "name": "final", "desc": "Returns any remaining enciphered contents, with output_encoding
\nbeing one of: 'binary'
, 'base64'
or 'hex'
. If no encoding is\nprovided, then a buffer is returned.\n\n
Note: cipher
object can not be used after final()
method has been\ncalled.\n\n
You can disable automatic padding of the input data to block size. If\nauto_padding
is false, the length of the entire input data must be a\nmultiple of the cipher's block size or final
will fail. Useful for\nnon-standard padding, e.g. using 0x0
instead of PKCS padding. You\nmust call this before cipher.final
.\n\n
For authenticated encryption modes (currently supported: GCM), this\nmethod returns a Buffer
that represents the authentication tag that\nhas been computed from the given data. Should be called after\nencryption has been completed using the final
method!\n\n
For authenticated encryption modes (currently supported: GCM), this\nmethod sets the value used for the additional authenticated data (AAD) input\nparameter.\n\n\n
\n", "signatures": [ { "params": [ { "name": "buffer" } ] } ] } ] }, { "textRaw": "Class: Decipher", "type": "class", "name": "Decipher", "desc": "Class for decrypting data.\n\n
\nReturned by crypto.createDecipher
and crypto.createDecipheriv
.\n\n
Decipher objects are streams that are both readable and\nwritable. The written enciphered data is used to produce the\nplain-text data on the the readable side. The legacy update
and\nfinal
methods are also supported.\n\n
Updates the decipher with data
, which is encoded in 'binary'
,\n'base64'
or 'hex'
. If no encoding is provided, then a buffer is\nexpected.\nIf data
is a Buffer
then input_encoding
is ignored.\n\n
The output_decoding
specifies in what format to return the\ndeciphered plaintext: 'binary'
, 'ascii'
or 'utf8'
. If no\nencoding is provided, then a buffer is returned.\n\n
Returns any remaining plaintext which is deciphered, with\noutput_encoding
being one of: 'binary'
, 'ascii'
or 'utf8'
. If\nno encoding is provided, then a buffer is returned.\n\n
Note: decipher
object can not be used after final()
method has been\ncalled.\n\n
You can disable auto padding if the data has been encrypted without\nstandard block padding to prevent decipher.final
from checking and\nremoving it. Can only work if the input data's length is a multiple of\nthe ciphers block size. You must call this before streaming data to\ndecipher.update
.\n\n
For authenticated encryption modes (currently supported: GCM), this\nmethod must be used to pass in the received authentication tag.\nIf no tag is provided or if the ciphertext has been tampered with,\nfinal
will throw, thus indicating that the ciphertext should\nbe discarded due to failed authentication.\n\n
For authenticated encryption modes (currently supported: GCM), this\nmethod sets the value used for the additional authenticated data (AAD) input\nparameter.\n\n\n
\n", "signatures": [ { "params": [ { "name": "buffer" } ] } ] } ] }, { "textRaw": "Class: Sign", "type": "class", "name": "Sign", "desc": "Class for generating signatures.\n\n
\nReturned by crypto.createSign
.\n\n
Sign objects are writable streams. The written data is\nused to generate the signature. Once all of the data has been\nwritten, the sign
method will return the signature. The legacy\nupdate
method is also supported.\n\n
Updates the sign object with data. This can be called many times\nwith new data as it is streamed.\n\n
\n", "signatures": [ { "params": [ { "name": "data" } ] } ] }, { "textRaw": "sign.sign(private_key[, output_format])", "type": "method", "name": "sign", "desc": "Calculates the signature on all the updated data passed through the\nsign.\n\n
\nprivate_key
can be an object or a string. If private_key
is a string, it is\ntreated as the key with no passphrase.\n\n
private_key
:\n\n
key
: A string holding the PEM encoded private keypassphrase
: A string of passphrase for the private keyReturns the signature in output_format
which can be 'binary'
,\n'hex'
or 'base64'
. If no encoding is provided, then a buffer is\nreturned.\n\n
Note: sign
object can not be used after sign()
method has been\ncalled.\n\n
Class for verifying signatures.\n\n
\nReturned by crypto.createVerify
.\n\n
Verify objects are writable streams. The written data\nis used to validate against the supplied signature. Once all of the\ndata has been written, the verify
method will return true if the\nsupplied signature is valid. The legacy update
method is also\nsupported.\n\n
Updates the verifier object with data. This can be called many times\nwith new data as it is streamed.\n\n
\n", "signatures": [ { "params": [ { "name": "data" } ] } ] }, { "textRaw": "verifier.verify(object, signature[, signature_format])", "type": "method", "name": "verify", "desc": "Verifies the signed data by using the object
and signature
.\nobject
is a string containing a PEM encoded object, which can be\none of RSA public key, DSA public key, or X.509 certificate.\nsignature
is the previously calculated signature for the data, in\nthe signature_format
which can be 'binary'
, 'hex'
or 'base64'
.\nIf no encoding is specified, then a buffer is expected.\n\n
Returns true or false depending on the validity of the signature for\nthe data and public key.\n\n
\nNote: verifier
object can not be used after verify()
method has been\ncalled.\n\n
The class for creating Diffie-Hellman key exchanges.\n\n
\nReturned by crypto.createDiffieHellman
.\n\n
A bit field containing any warnings and/or errors as a result of a check performed\nduring initialization. The following values are valid for this property\n(defined in constants
module):\n\n
DH_CHECK_P_NOT_SAFE_PRIME
DH_CHECK_P_NOT_PRIME
DH_UNABLE_TO_CHECK_GENERATOR
DH_NOT_SUITABLE_GENERATOR
Generates private and public Diffie-Hellman key values, and returns\nthe public key in the specified encoding. This key should be\ntransferred to the other party. Encoding can be 'binary'
, 'hex'
,\nor 'base64'
. If no encoding is provided, then a buffer is returned.\n\n
Computes the shared secret using other_public_key
as the other\nparty's public key and returns the computed shared secret. Supplied\nkey is interpreted using specified input_encoding
, and secret is\nencoded using specified output_encoding
. Encodings can be\n'binary'
, 'hex'
, or 'base64'
. If the input encoding is not\nprovided, then a buffer is expected.\n\n
If no output encoding is given, then a buffer is returned.\n\n
\n", "signatures": [ { "params": [ { "name": "other_public_key" }, { "name": "input_encoding", "optional": true }, { "name": "output_encoding", "optional": true } ] } ] }, { "textRaw": "diffieHellman.getPrime([encoding])", "type": "method", "name": "getPrime", "desc": "Returns the Diffie-Hellman prime in the specified encoding, which can\nbe 'binary'
, 'hex'
, or 'base64'
. If no encoding is provided,\nthen a buffer is returned.\n\n
Returns the Diffie-Hellman generator in the specified encoding, which can\nbe 'binary'
, 'hex'
, or 'base64'
. If no encoding is provided,\nthen a buffer is returned.\n\n
Returns the Diffie-Hellman public key in the specified encoding, which\ncan be 'binary'
, 'hex'
, or 'base64'
. If no encoding is provided,\nthen a buffer is returned.\n\n
Returns the Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary'
, 'hex'
, or 'base64'
. If no encoding is\nprovided, then a buffer is returned.\n\n
Sets the Diffie-Hellman public key. Key encoding can be 'binary'
,\n'hex'
or 'base64'
. If no encoding is provided, then a buffer is\nexpected.\n\n
Sets the Diffie-Hellman private key. Key encoding can be 'binary'
,\n'hex'
or 'base64'
. If no encoding is provided, then a buffer is\nexpected.\n\n
The class for creating EC Diffie-Hellman key exchanges.\n\n
\nReturned by crypto.createECDH
.\n\n
Generates private and public EC Diffie-Hellman key values, and returns\nthe public key in the specified format and encoding. This key should be\ntransferred to the other party.\n\n
\nFormat specifies point encoding and can be 'compressed'
, 'uncompressed'
, or\n'hybrid'
. If no format is provided - the point will be returned in\n'uncompressed'
format.\n\n
Encoding can be 'binary'
, 'hex'
, or 'base64'
. If no encoding is provided,\nthen a buffer is returned.\n\n
Computes the shared secret using other_public_key
as the other\nparty's public key and returns the computed shared secret. Supplied\nkey is interpreted using specified input_encoding
, and secret is\nencoded using specified output_encoding
. Encodings can be\n'binary'
, 'hex'
, or 'base64'
. If the input encoding is not\nprovided, then a buffer is expected.\n\n
If no output encoding is given, then a buffer is returned.\n\n
\n", "signatures": [ { "params": [ { "name": "other_public_key" }, { "name": "input_encoding", "optional": true }, { "name": "output_encoding", "optional": true } ] } ] }, { "textRaw": "ECDH.getPublicKey([encoding[, format]])", "type": "method", "name": "getPublicKey", "desc": "Returns the EC Diffie-Hellman public key in the specified encoding and format.\n\n
\nFormat specifies point encoding and can be 'compressed'
, 'uncompressed'
, or\n'hybrid'
. If no format is provided - the point will be returned in\n'uncompressed'
format.\n\n
Encoding can be 'binary'
, 'hex'
, or 'base64'
. If no encoding is provided,\nthen a buffer is returned.\n\n
Returns the EC Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary'
, 'hex'
, or 'base64'
. If no encoding is\nprovided, then a buffer is returned.\n\n
Sets the EC Diffie-Hellman public key. Key encoding can be 'binary'
,\n'hex'
or 'base64'
. If no encoding is provided, then a buffer is\nexpected.\n\n
Sets the EC Diffie-Hellman private key. Key encoding can be 'binary'
,\n'hex'
or 'base64'
. If no encoding is provided, then a buffer is\nexpected.\n\n
Example (obtaining a shared secret):\n\n
\nvar crypto = require('crypto');\nvar alice = crypto.createECDH('secp256k1');\nvar bob = crypto.createECDH('secp256k1');\n\nalice.generateKeys();\nbob.generateKeys();\n\nvar alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nvar bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* alice_secret and bob_secret should be the same */\nconsole.log(alice_secret == bob_secret);
\n",
"signatures": [
{
"params": [
{
"name": "private_key"
},
{
"name": "encoding",
"optional": true
}
]
}
]
}
]
},
{
"textRaw": "Class: Certificate",
"type": "class",
"name": "Certificate",
"desc": "The class used for working with signed public key & challenges. The most\ncommon usage for this series of functions is when dealing with the <keygen>
\nelement. http://www.openssl.org/docs/apps/spkac.html\n\n
Returned by crypto.Certificate
.\n\n
Returns true of false based on the validity of the SPKAC.\n\n
\n", "signatures": [ { "params": [ { "name": "spkac" } ] } ] }, { "textRaw": "Certificate.exportChallenge(spkac)", "type": "method", "name": "exportChallenge", "desc": "Exports the encoded public key from the supplied SPKAC.\n\n
\n", "signatures": [ { "params": [ { "name": "spkac" } ] } ] }, { "textRaw": "Certificate.exportPublicKey(spkac)", "type": "method", "name": "exportPublicKey", "desc": "Exports the encoded challenge associated with the SPKAC.\n\n
\n", "signatures": [ { "params": [ { "name": "spkac" } ] } ] } ] } ], "properties": [ { "textRaw": "crypto.DEFAULT_ENCODING", "name": "DEFAULT_ENCODING", "desc": "The default encoding to use for functions that can take either strings\nor buffers. The default value is 'buffer'
, which makes it default\nto using Buffer objects. This is here to make the crypto module more\neasily compatible with legacy programs that expected 'binary'
to be\nthe default encoding.\n\n
Note that new programs will probably expect buffers, so only use this\nas a temporary measure.\n\n
\n" } ], "modules": [ { "textRaw": "Recent API Changes", "name": "recent_api_changes", "desc": "The Crypto module was added to Node before there was the concept of a\nunified Stream API, and before there were Buffer objects for handling\nbinary data.\n\n
\nAs such, the streaming classes don't have the typical methods found on\nother Node classes, and many methods accepted and returned\nBinary-encoded strings by default rather than Buffers. This was\nchanged to use Buffers by default instead.\n\n
\nThis is a breaking change for some use cases, but not all.\n\n
\nFor example, if you currently use the default arguments to the Sign\nclass, and then pass the results to the Verify class, without ever\ninspecting the data, then it will continue to work as before. Where\nyou once got a binary string and then presented the binary string to\nthe Verify object, you'll now get a Buffer, and present the Buffer to\nthe Verify object.\n\n
\nHowever, if you were doing things with the string data that will not\nwork properly on Buffers (such as, concatenating them, storing in\ndatabases, etc.), or you are passing binary strings to the crypto\nfunctions without an encoding argument, then you will need to start\nproviding encoding arguments to specify which encoding you'd like to\nuse. To switch to the previous style of using binary strings by\ndefault, set the crypto.DEFAULT_ENCODING
field to 'binary'. Note\nthat new programs will probably expect buffers, so only use this as a\ntemporary measure.\n\n\n