lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-02 22:02:25 +03:00
Code Activity

HACKING-CRYPTO: fixups [ci skip]

Browse Source 
Follow-up to f64885b6ab #1297
This commit is contained in:
Viktor Szakats
2024-01-12 00:59:17 +00:00
parent 4558f0c2e8
commit cf5364f303
1 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/HACKING-CRYPTO
View File

@ -111,11 +111,12 @@ Release the context.
Note: if the ctx parameter is modified by the underlying code, Note: if the ctx parameter is modified by the underlying code,
this procedure must be implemented as a macro to map ctx --> &ctx. this procedure must be implemented as a macro to map ctx --> &ctx.
void libssh2_hmac_sha1_init(libssh2_hmac_ctx *ctx, int libssh2_hmac_sha1_init(libssh2_hmac_ctx *ctx,
const void *key, const void *key,
int keylen); int keylen);
Setup the HMAC computation context ctx for an HMAC-SHA-1 computation using the Setup the HMAC computation context ctx for an HMAC-SHA-1 computation using the
keylen-byte key. Is invoked just after libssh2_hmac_ctx_init(). keylen-byte key. Is invoked just after libssh2_hmac_ctx_init().
Returns 1 for success and 0 for failure.
3.2) SHA-256 3.2) SHA-256
Must always be implemented. Must always be implemented.
@ -156,11 +157,12 @@ LIBSSH2_HMAC_SHA256
#define as 1 if the crypto library supports HMAC-SHA-256, else 0. #define as 1 if the crypto library supports HMAC-SHA-256, else 0.
If defined as 0, the rest of this section can be omitted. If defined as 0, the rest of this section can be omitted.
void libssh2_hmac_sha256_init(libssh2_hmac_ctx *ctx, int libssh2_hmac_sha256_init(libssh2_hmac_ctx *ctx,
const void *key, const void *key,
int keylen); int keylen);
Setup the HMAC computation context ctx for an HMAC-256 computation using the Setup the HMAC computation context ctx for an HMAC-256 computation using the
keylen-byte key. Is invoked just after libssh2_hmac_ctx_init(). keylen-byte key. Is invoked just after libssh2_hmac_ctx_init().
Returns 1 for success and 0 for failure.
3.3) SHA-384 3.3) SHA-384
Mandatory if ECDSA is implemented. Can be omitted otherwise. Mandatory if ECDSA is implemented. Can be omitted otherwise.
@ -235,11 +237,12 @@ LIBSSH2_HMAC_SHA512
#define as 1 if the crypto library supports HMAC-SHA-512, else 0. #define as 1 if the crypto library supports HMAC-SHA-512, else 0.
If defined as 0, the rest of this section can be omitted. If defined as 0, the rest of this section can be omitted.
void libssh2_hmac_sha512_init(libssh2_hmac_ctx *ctx, int libssh2_hmac_sha512_init(libssh2_hmac_ctx *ctx,
const void *key, const void *key,
int keylen); int keylen);
Setup the HMAC computation context ctx for an HMAC-512 computation using the Setup the HMAC computation context ctx for an HMAC-512 computation using the
keylen-byte key. Is invoked just after libssh2_hmac_ctx_init(). keylen-byte key. Is invoked just after libssh2_hmac_ctx_init().
Returns 1 for success and 0 for failure.
3.5) MD5 3.5) MD5
LIBSSH2_MD5 LIBSSH2_MD5
@ -271,20 +274,21 @@ Release the context.
Note: if the ctx parameter is modified by the underlying code, Note: if the ctx parameter is modified by the underlying code,
this procedure must be implemented as a macro to map ctx --> &ctx. this procedure must be implemented as a macro to map ctx --> &ctx.
void libssh2_hmac_md5_init(libssh2_hmac_ctx *ctx, int libssh2_hmac_md5_init(libssh2_hmac_ctx *ctx,
const void *key, const void *key,
int keylen); int keylen);
Setup the HMAC computation context ctx for an HMAC-MD5 computation using the Setup the HMAC computation context ctx for an HMAC-MD5 computation using the
keylen-byte key. Is invoked just after libssh2_hmac_ctx_init(). keylen-byte key. Is invoked just after libssh2_hmac_ctx_init().
Returns 1 for success and 0 for failure.
3.6) RIPEMD-160 3.6) RIPEMD-160
LIBSSH2_HMAC_RIPEMD LIBSSH2_HMAC_RIPEMD
#define as 1 if the crypto library supports HMAC-RIPEMD-160, else 0. #define as 1 if the crypto library supports HMAC-RIPEMD-160, else 0.
If defined as 0, the rest of this section can be omitted. If defined as 0, the rest of this section can be omitted.
void libssh2_hmac_ripemd160_init(libssh2_hmac_ctx *ctx, int libssh2_hmac_ripemd160_init(libssh2_hmac_ctx *ctx,
const void *key, const void *key,
int keylen); int keylen);
Setup the HMAC computation context ctx for an HMAC-RIPEMD-160 computation using Setup the HMAC computation context ctx for an HMAC-RIPEMD-160 computation using
the keylen-byte key. Is invoked just after libssh2_hmac_ctx_init(). the keylen-byte key. Is invoked just after libssh2_hmac_ctx_init().
Returns 1 for success and 0 for failure. Returns 1 for success and 0 for failure.