J-PAKE is not experimental in HEAD.
[openssl.git] / crypto / jpake / jpake.h
index 4c67a24..8beb9a5 100644 (file)
@@ -8,6 +8,8 @@
 #ifndef HEADER_JPAKE_H
 #define HEADER_JPAKE_H
 
+#include <openssl/opensslconf.h>
+
 #ifdef  __cplusplus
 extern "C" {
 #endif
@@ -17,23 +19,23 @@ extern "C" {
 
 typedef struct JPAKE_CTX JPAKE_CTX;
 
-// Note that "g" in the ZKPs is not necessarily the J-PAKE g.
+/* Note that "g" in the ZKPs is not necessarily the J-PAKE g. */
 typedef struct
     {
-    BIGNUM *gr;  // g^r (r random)
-    BIGNUM *b;   // b = r - x*h, h=hash(g, g^r, g^x, name)
+    BIGNUM *gr; /* g^r (r random) */
+    BIGNUM *b;  /* b = r - x*h, h=hash(g, g^r, g^x, name) */
     } JPAKE_ZKP;
 
 typedef struct
     {
-    BIGNUM *gx;        // g^x in step 1, g^(xa + xc + xd) * xb * s in step 2
-    JPAKE_ZKP zkpx;    // ZKP(x) or ZKP(xb * s)
+    BIGNUM *gx;       /* g^x in step 1, g^(xa + xc + xd) * xb * s in step 2 */
+    JPAKE_ZKP zkpx;   /* ZKP(x) or ZKP(xb * s) */
     } JPAKE_STEP_PART;
 
 typedef struct
     {
-    JPAKE_STEP_PART p1;    // g^x3, ZKP(x3) or g^x1, ZKP(x1)
-    JPAKE_STEP_PART p2;    // g^x4, ZKP(x4) or g^x2, ZKP(x2)
+    JPAKE_STEP_PART p1;   /* g^x3, ZKP(x3) or g^x1, ZKP(x1) */
+    JPAKE_STEP_PART p2;   /* g^x4, ZKP(x4) or g^x2, ZKP(x2) */
     } JPAKE_STEP1;
 
 typedef JPAKE_STEP_PART JPAKE_STEP2;
@@ -48,29 +50,35 @@ typedef struct
     unsigned char hk[SHA_DIGEST_LENGTH];
     } JPAKE_STEP3B;
 
-// Parameters are copied
+/* Parameters are copied */
 JPAKE_CTX *JPAKE_CTX_new(const char *name, const char *peer_name,
                         const BIGNUM *p, const BIGNUM *g, const BIGNUM *q,
                         const BIGNUM *secret);
 void JPAKE_CTX_free(JPAKE_CTX *ctx);
 
-// Note that JPAKE_STEP1 can be used multiple times before release
-// without another init.
+/*
+ * Note that JPAKE_STEP1 can be used multiple times before release
+ * without another init.
+ */
 void JPAKE_STEP1_init(JPAKE_STEP1 *s1);
 int JPAKE_STEP1_generate(JPAKE_STEP1 *send, JPAKE_CTX *ctx);
 int JPAKE_STEP1_process(JPAKE_CTX *ctx, const JPAKE_STEP1 *received);
 void JPAKE_STEP1_release(JPAKE_STEP1 *s1);
 
-// Note that JPAKE_STEP2 can be used multiple times before release
-// without another init.
+/*
+ * Note that JPAKE_STEP2 can be used multiple times before release
+ * without another init.
+ */
 void JPAKE_STEP2_init(JPAKE_STEP2 *s2);
 int JPAKE_STEP2_generate(JPAKE_STEP2 *send, JPAKE_CTX *ctx);
 int JPAKE_STEP2_process(JPAKE_CTX *ctx, const JPAKE_STEP2 *received);
 void JPAKE_STEP2_release(JPAKE_STEP2 *s2);
 
-// Optionally verify the shared key. If the shared secrets do not
-// match, the two ends will disagree about the shared key, but
-// otherwise the protocol will succeed.
+/*
+ * Optionally verify the shared key. If the shared secrets do not
+ * match, the two ends will disagree about the shared key, but
+ * otherwise the protocol will succeed.
+ */
 void JPAKE_STEP3A_init(JPAKE_STEP3A *s3a);
 int JPAKE_STEP3A_generate(JPAKE_STEP3A *send, JPAKE_CTX *ctx);
 int JPAKE_STEP3A_process(JPAKE_CTX *ctx, const JPAKE_STEP3A *received);
@@ -81,8 +89,10 @@ int JPAKE_STEP3B_generate(JPAKE_STEP3B *send, JPAKE_CTX *ctx);
 int JPAKE_STEP3B_process(JPAKE_CTX *ctx, const JPAKE_STEP3B *received);
 void JPAKE_STEP3B_release(JPAKE_STEP3B *s3b);
 
-// the return value belongs to the library and will be released when
-// ctx is released, and will change when a new handshake is performed.
+/*
+ * the return value belongs to the library and will be released when
+ * ctx is released, and will change when a new handshake is performed.
+ */
 const BIGNUM *JPAKE_get_shared_key(JPAKE_CTX *ctx);
 
 /* BEGIN ERROR CODES */