xref: /netbsd-src/crypto/external/bsd/openssh/dist/sshkey-xmss.h (revision 867d70fc718005c0918b8b8b2f9d7f2d52d0a0db)
1 /*	$NetBSD: sshkey-xmss.h,v 1.4 2021/04/19 14:40:15 christos Exp $	*/
2 /* $OpenBSD: sshkey-xmss.h,v 1.3 2021/04/03 06:18:41 djm Exp $ */
3 
4 /*
5  * Copyright (c) 2017 Markus Friedl.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef SSHKEY_XMSS_H
28 #define SSHKEY_XMSS_H
29 
30 #define XMSS_SHA2_256_W16_H10_NAME	"XMSS_SHA2-256_W16_H10"
31 #define XMSS_SHA2_256_W16_H16_NAME	"XMSS_SHA2-256_W16_H16"
32 #define XMSS_SHA2_256_W16_H20_NAME	"XMSS_SHA2-256_W16_H20"
33 #define XMSS_DEFAULT_NAME		XMSS_SHA2_256_W16_H10_NAME
34 
35 size_t	 sshkey_xmss_pklen(const struct sshkey *);
36 size_t	 sshkey_xmss_sklen(const struct sshkey *);
37 int	 sshkey_xmss_init(struct sshkey *, const char *);
38 void	 sshkey_xmss_free_state(struct sshkey *);
39 int	 sshkey_xmss_generate_private_key(struct sshkey *, u_int);
40 int	 sshkey_xmss_serialize_state(const struct sshkey *, struct sshbuf *);
41 int	 sshkey_xmss_serialize_state_opt(const struct sshkey *, struct sshbuf *,
42 	    enum sshkey_serialize_rep);
43 int	 sshkey_xmss_serialize_pk_info(const struct sshkey *, struct sshbuf *,
44 	    enum sshkey_serialize_rep);
45 int	 sshkey_xmss_deserialize_state(struct sshkey *, struct sshbuf *);
46 int	 sshkey_xmss_deserialize_state_opt(struct sshkey *, struct sshbuf *);
47 int	 sshkey_xmss_deserialize_pk_info(struct sshkey *, struct sshbuf *);
48 
49 int	 sshkey_xmss_siglen(const struct sshkey *, size_t *);
50 void	*sshkey_xmss_params(const struct sshkey *);
51 void	*sshkey_xmss_bds_state(const struct sshkey *);
52 int	 sshkey_xmss_get_state(const struct sshkey *, int);
53 int	 sshkey_xmss_enable_maxsign(struct sshkey *, u_int32_t);
54 int	 sshkey_xmss_forward_state(const struct sshkey *, u_int32_t);
55 int	 sshkey_xmss_update_state(const struct sshkey *, int);
56 u_int32_t sshkey_xmss_signatures_left(const struct sshkey *);
57 
58 #endif /* SSHKEY_XMSS_H */
59