Skip to content

Commit 9901415

Browse files
jas-trevnorris
authored andcommitted
doc: crypto: document SPKAC additions
Document the SPKAC functionality that was added in commit 7bf46ba.
1 parent 7bf46ba commit 9901415

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

doc/api/crypto.markdown

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,26 @@ such as in the generation of encryption keys.
474474

475475
Usage is otherwise identical to `crypto.randomBytes`.
476476

477+
## Class: Certificate
478+
479+
The class used for working with signed public key & challenges. The most
480+
common usage for this series of functions is when dealing with the `<keygen>`
481+
element. http://www.openssl.org/docs/apps/spkac.html
482+
483+
Returned by `crypto.Certificate`.
484+
485+
### Certificate.verifySpkac(spkac)
486+
487+
Returns true of false based on the validity of the SPKAC.
488+
489+
### Certificate.exportChallenge(spkac)
490+
491+
Exports the encoded public key from the supplied SPKAC.
492+
493+
### Certificate.exportPublicKey(spkac)
494+
495+
Exports the encoded challenge associated with the SPKAC.
496+
477497
## crypto.DEFAULT_ENCODING
478498

479499
The default encoding to use for functions that can take either strings

0 commit comments

Comments
 (0)