doc: crypto: document SPKAC additions
authorJason Gerfen <jason.gerfen@gmail.com>
Tue, 15 Oct 2013 14:31:14 +0000 (08:31 -0600)
committerTrevor Norris <trev.norris@gmail.com>
Wed, 16 Oct 2013 16:44:46 +0000 (09:44 -0700)
Document the SPKAC functionality that was added in commit 7bf46ba.

doc/api/crypto.markdown

index 27b0362..925eb58 100644 (file)
@@ -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