key.h revision 248619 
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#include <openssl/rsa.h>
31#include <openssl/dsa.h>
32#ifdef OPENSSL_HAS_ECC
33#include <openssl/ec.h>
34#endif
35
36typedef struct Key Key;
37enum types {
38	KEY_RSA1,
39	KEY_RSA,
40	KEY_DSA,
41	KEY_ECDSA,
42	KEY_RSA_CERT,
43	KEY_DSA_CERT,
44	KEY_ECDSA_CERT,
45	KEY_RSA_CERT_V00,
46	KEY_DSA_CERT_V00,
47	KEY_UNSPEC
48};
49enum fp_type {
50	SSH_FP_SHA1,
51	SSH_FP_MD5,
52	SSH_FP_SHA256
53};
54enum fp_rep {
55	SSH_FP_HEX,
56	SSH_FP_BUBBLEBABBLE,
57	SSH_FP_RANDOMART
58};
59
60/* key is stored in external hardware */
61#define KEY_FLAG_EXT		0x0001
62
63#define CERT_MAX_PRINCIPALS	256
64struct KeyCert {
65	Buffer		 certblob; /* Kept around for use on wire */
66	u_int		 type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
67	u_int64_t	 serial;
68	char		*key_id;
69	u_int		 nprincipals;
70	char		**principals;
71	u_int64_t	 valid_after, valid_before;
72	Buffer		 critical;
73	Buffer		 extensions;
74	Key		*signature_key;
75};
76
77struct Key {
78	int	 type;
79	int	 flags;
80	RSA	*rsa;
81	DSA	*dsa;
82	int	 ecdsa_nid;	/* NID of curve */
83#ifdef OPENSSL_HAS_ECC
84	EC_KEY	*ecdsa;
85#else
86	void	*ecdsa;
87#endif
88	struct KeyCert *cert;
89};
90
91Key		*key_new(int);
92void		 key_add_private(Key *);
93Key		*key_new_private(int);
94void		 key_free(Key *);
95Key		*key_demote(const Key *);
96int		 key_equal_public(const Key *, const Key *);
97int		 key_equal(const Key *, const Key *);
98char		*key_fingerprint(Key *, enum fp_type, enum fp_rep);
99u_char		*key_fingerprint_raw(const Key *, enum fp_type, u_int *);
100const char	*key_type(const Key *);
101const char	*key_cert_type(const Key *);
102int		 key_write(const Key *, FILE *);
103int		 key_read(Key *, char **);
104u_int		 key_size(const Key *);
105
106Key	*key_generate(int, u_int);
107Key	*key_from_private(const Key *);
108int	 key_type_from_name(char *);
109int	 key_is_cert(const Key *);
110int	 key_type_plain(int);
111int	 key_to_certified(Key *, int);
112int	 key_drop_cert(Key *);
113int	 key_certify(Key *, Key *);
114void	 key_cert_copy(const Key *, struct Key *);
115int	 key_cert_check_authority(const Key *, int, int, const char *,
116	    const char **);
117int	 key_cert_is_legacy(const Key *);
118
119int		 key_ecdsa_nid_from_name(const char *);
120int		 key_curve_name_to_nid(const char *);
121const char *	 key_curve_nid_to_name(int);
122u_int		 key_curve_nid_to_bits(int);
123int		 key_ecdsa_bits_to_nid(int);
124#ifdef OPENSSL_HAS_ECC
125int		 key_ecdsa_key_to_nid(EC_KEY *);
126const EVP_MD *	 key_ec_nid_to_evpmd(int nid);
127int		 key_ec_validate_public(const EC_GROUP *, const EC_POINT *);
128int		 key_ec_validate_private(const EC_KEY *);
129#endif
130
131Key		*key_from_blob(const u_char *, u_int);
132int		 key_to_blob(const Key *, u_char **, u_int *);
133const char	*key_ssh_name(const Key *);
134const char	*key_ssh_name_plain(const Key *);
135int		 key_names_valid2(const char *);
136
137int	 key_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
138int	 key_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
139
140int	 ssh_dss_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
141int	 ssh_dss_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
142int	 ssh_ecdsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
143int	 ssh_ecdsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
144int	 ssh_rsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
145int	 ssh_rsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
146
147#if defined(OPENSSL_HAS_ECC) && (defined(DEBUG_KEXECDH) || defined(DEBUG_PK))
148void	key_dump_ec_point(const EC_GROUP *, const EC_POINT *);
149void	key_dump_ec_key(const EC_KEY *);
150#endif
151
152#endif
153