1/* $OpenBSD: key.h,v 1.35 2013/01/17 23:00:01 djm Exp $ */
2
3/*
4 * Copyright (c) 2000, 2001 Markus Friedl.  All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26#ifndef KEY_H
27#define KEY_H
28
29#include "buffer.h"
30
31#ifdef __APPLE_CRYPTO__
32#include "ossl-rsa.h"
33#include "ossl-dsa.h"
34#else
35#include <openssl/rsa.h>
36#include <openssl/dsa.h>
37#ifdef OPENSSL_HAS_ECC
38#include <openssl/ec.h>
39#endif
40#endif /* __APPLE_CRYPTO__ */
41
42typedef struct Key Key;
43enum types {
44	KEY_RSA1,
45	KEY_RSA,
46	KEY_DSA,
47	KEY_ECDSA,
48	KEY_RSA_CERT,
49	KEY_DSA_CERT,
50	KEY_ECDSA_CERT,
51	KEY_RSA_CERT_V00,
52	KEY_DSA_CERT_V00,
53	KEY_NULL,
54	KEY_UNSPEC
55};
56enum fp_type {
57	SSH_FP_SHA1,
58	SSH_FP_MD5,
59	SSH_FP_SHA256
60};
61enum fp_rep {
62	SSH_FP_HEX,
63	SSH_FP_BUBBLEBABBLE,
64	SSH_FP_RANDOMART
65};
66
67/* key is stored in external hardware */
68#define KEY_FLAG_EXT		0x0001
69
70#define CERT_MAX_PRINCIPALS	256
71struct KeyCert {
72	Buffer		 certblob; /* Kept around for use on wire */
73	u_int		 type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
74	u_int64_t	 serial;
75	char		*key_id;
76	u_int		 nprincipals;
77	char		**principals;
78	u_int64_t	 valid_after, valid_before;
79	Buffer		 critical;
80	Buffer		 extensions;
81	Key		*signature_key;
82};
83
84struct Key {
85	int	 type;
86	int	 flags;
87	RSA	*rsa;
88	DSA	*dsa;
89	int	 ecdsa_nid;	/* NID of curve */
90#ifdef OPENSSL_HAS_ECC
91	EC_KEY	*ecdsa;
92#else
93	void	*ecdsa;
94#endif
95	struct KeyCert *cert;
96};
97
98Key		*key_new(int);
99void		 key_add_private(Key *);
100Key		*key_new_private(int);
101void		 key_free(Key *);
102Key		*key_demote(const Key *);
103int		 key_equal_public(const Key *, const Key *);
104int		 key_equal(const Key *, const Key *);
105char		*key_fingerprint(Key *, enum fp_type, enum fp_rep);
106u_char		*key_fingerprint_raw(const Key *, enum fp_type, u_int *);
107const char	*key_type(const Key *);
108const char	*key_cert_type(const Key *);
109int		 key_write(const Key *, FILE *);
110int		 key_read(Key *, char **);
111u_int		 key_size(const Key *);
112
113Key	*key_generate(int, u_int);
114Key	*key_from_private(const Key *);
115int	 key_type_from_name(char *);
116int	 key_is_cert(const Key *);
117int	 key_type_plain(int);
118int	 key_to_certified(Key *, int);
119int	 key_drop_cert(Key *);
120int	 key_certify(Key *, Key *);
121void	 key_cert_copy(const Key *, struct Key *);
122int	 key_cert_check_authority(const Key *, int, int, const char *,
123	    const char **);
124int	 key_cert_is_legacy(const Key *);
125
126int		 key_ecdsa_nid_from_name(const char *);
127int		 key_curve_name_to_nid(const char *);
128const char *	 key_curve_nid_to_name(int);
129u_int		 key_curve_nid_to_bits(int);
130int		 key_ecdsa_bits_to_nid(int);
131#ifdef OPENSSL_HAS_ECC
132int		 key_ecdsa_key_to_nid(EC_KEY *);
133const EVP_MD *	 key_ec_nid_to_evpmd(int nid);
134int		 key_ec_validate_public(const EC_GROUP *, const EC_POINT *);
135int		 key_ec_validate_private(const EC_KEY *);
136#endif
137
138Key		*key_from_blob(const u_char *, u_int);
139int		 key_to_blob(const Key *, u_char **, u_int *);
140const char	*key_ssh_name(const Key *);
141const char	*key_ssh_name_plain(const Key *);
142int		 key_names_valid2(const char *);
143
144int	 key_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
145int	 key_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
146
147int	 ssh_dss_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
148int	 ssh_dss_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
149int	 ssh_ecdsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
150int	 ssh_ecdsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
151int	 ssh_rsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
152int	 ssh_rsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
153
154#if defined(OPENSSL_HAS_ECC) && (defined(DEBUG_KEXECDH) || defined(DEBUG_PK))
155void	key_dump_ec_point(const EC_GROUP *, const EC_POINT *);
156void	key_dump_ec_key(const EC_KEY *);
157#endif
158
159#endif
160