From: Jason Gerfen <jason.gerfen@gmail.com>
Date: Tue, 15 Oct 2013 14:31:14 +0000 (-0600)
Subject: doc: crypto: document SPKAC additions
X-Git-Tag: v0.11.8~36
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=aa94450b31a28d6251df3b88fdd652ddd1e67a69;p=platform%2Fupstream%2Fnodejs.git

doc: crypto: document SPKAC additions

Document the SPKAC functionality that was added in commit 7f66e44.
---

diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
index 27b0362..925eb58 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