xref: /freebsd/crypto/openssh/digest.h (revision 27c43fe1f3795622c5bd4bbfc465a29a800c0799)
1 /* $OpenBSD: digest.h,v 1.1 2014/01/09 23:20:00 djm Exp $ */
2 /*
3  * Copyright (c) 2013 Damien Miller <djm@mindrot.org>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #ifndef _DIGEST_H
19 #define _DIGEST_H
20 
21 /* Maximum digest output length */
22 #define SSH_DIGEST_MAX_LENGTH	64
23 
24 /* Digest algorithms */
25 #define SSH_DIGEST_MD5		0
26 #define SSH_DIGEST_RIPEMD160	1
27 #define SSH_DIGEST_SHA1		2
28 #define SSH_DIGEST_SHA256	3
29 #define SSH_DIGEST_SHA384	4
30 #define SSH_DIGEST_SHA512	5
31 #define SSH_DIGEST_MAX		6
32 
33 /* Returns the algorithm's digest length in bytes or 0 for invalid algorithm */
34 size_t ssh_digest_bytes(int alg);
35 
36 /* One-shot API */
37 int ssh_digest_memory(int alg, const void *m, size_t mlen,
38     u_char *d, size_t dlen)
39 	__attribute__((__bounded__(__buffer__, 2, 3)))
40 	__attribute__((__bounded__(__buffer__, 4, 5)));
41 int ssh_digest_buffer(int alg, const Buffer *b, u_char *d, size_t dlen)
42 	__attribute__((__bounded__(__buffer__, 3, 4)));
43 
44 /* Update API */
45 struct ssh_digest_ctx;
46 struct ssh_digest_ctx *ssh_digest_start(int alg);
47 int ssh_digest_update(struct ssh_digest_ctx *ctx, const void *m, size_t mlen)
48 	__attribute__((__bounded__(__buffer__, 2, 3)));
49 int ssh_digest_update_buffer(struct ssh_digest_ctx *ctx, const Buffer *b);
50 int ssh_digest_final(struct ssh_digest_ctx *ctx, u_char *d, size_t dlen)
51 	__attribute__((__bounded__(__buffer__, 2, 3)));
52 void ssh_digest_free(struct ssh_digest_ctx *ctx);
53 
54 #endif /* _DIGEST_H */
55 
56