summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJason Gerfen <jason.gerfen@gmail.com>2013-10-15 08:31:14 -0600
committerBen Noordhuis <info@bnoordhuis.nl>2013-10-15 21:12:47 +0200
commitaa94450b31a28d6251df3b88fdd652ddd1e67a69 (patch)
treea2f3889bcf62ce0fa52b2f80c909486c6fe92cc1 /doc
parent7f66e44dc1e90e7abda2a9ed02d7e8163e1f6358 (diff)
downloadnode-new-aa94450b31a28d6251df3b88fdd652ddd1e67a69.tar.gz
doc: crypto: document SPKAC additions
Document the SPKAC functionality that was added in commit 7f66e44.
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.markdown20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
index 27b03622e8..925eb58933 100644
--- a/doc/api/crypto.markdown
+++ b/doc/api/crypto.markdown
@@ -474,6 +474,26 @@ such as in the generation of encryption keys.
Usage is otherwise identical to `crypto.randomBytes`.
+## Class: Certificate
+
+The class used for working with signed public key & challenges. The most
+common usage for this series of functions is when dealing with the `<keygen>`
+element. http://www.openssl.org/docs/apps/spkac.html
+
+Returned by `crypto.Certificate`.
+
+### Certificate.verifySpkac(spkac)
+
+Returns true of false based on the validity of the SPKAC.
+
+### Certificate.exportChallenge(spkac)
+
+Exports the encoded public key from the supplied SPKAC.
+
+### Certificate.exportPublicKey(spkac)
+
+Exports the encoded challenge associated with the SPKAC.
+
## crypto.DEFAULT_ENCODING
The default encoding to use for functions that can take either strings