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