public_key: Add new API functions to the documentation

KlausTrainer · May 8, 2013 · a9add4e · a9add4e
1 parent b968404
commit a9add4e
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
@@ -153,6 +153,19 @@
 
 <funcs>    
 
+  <func>
+    <name> compute_key(OthersKey, MyKey)-></name>
+    <name> compute_key(OthersKey, MyKey, Params)-></name>
+    <fsummary> Compute shared secret</fsummary>
+    <type>
+      <v>OthersKey = #'ECPoint'{} | binary(), MyKey = #'ECPrivateKey'{} | binary()</v>
+      <v>Params =  #'DHParameter'{}</v>
+    </type>
+  <desc>
+    <p> Compute shared secret </p>
+  </desc>
+  </func>
+
   <func>
     <name>decrypt_private(CipherText, Key) -> binary()</name>
     <name>decrypt_private(CipherText, Key, Options) -> binary()</name>
@@ -210,6 +223,17 @@
   </desc> 
   </func>
 
+  <func>
+    <name>generate_key(Params) -> {Public::binary(), Private::binary()}  | #'ECPrivateKey'{} </name>
+    <fsummary>Generates a new keypair</fsummary>
+    <type>
+      <v> Params = #'DHParameter'{} |  {namedCurve, oid()} |  #'OTPECParameters'{} </v>
+    </type>
+  <desc>
+    <p>Generates a new keypair</p>
+  </desc>
+  </func>
+
   <func>
     <name>pem_decode(PemBin) -> [pem_entry()]</name>
     <fsummary>Decode PEM binary data and return