key.h revision 207319
1/* $OpenBSD: key.h,v 1.29 2010/03/15 19:40:02 stevesk 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
33typedef struct Key Key;
34enum types {
35	KEY_RSA1,
36	KEY_RSA,
37	KEY_DSA,
38	KEY_RSA_CERT,
39	KEY_DSA_CERT,
40	KEY_UNSPEC
41};
42enum fp_type {
43	SSH_FP_SHA1,
44	SSH_FP_MD5
45};
46enum fp_rep {
47	SSH_FP_HEX,
48	SSH_FP_BUBBLEBABBLE,
49	SSH_FP_RANDOMART
50};
51
52/* key is stored in external hardware */
53#define KEY_FLAG_EXT		0x0001
54
55#define CERT_MAX_PRINCIPALS	256
56struct KeyCert {
57	Buffer		 certblob; /* Kept around for use on wire */
58	u_int		 type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
59	char		*key_id;
60	u_int		 nprincipals;
61	char		**principals;
62	u_int64_t	 valid_after, valid_before;
63	Buffer		 constraints;
64	Key		*signature_key;
65};
66
67struct Key {
68	int	 type;
69	int	 flags;
70	RSA	*rsa;
71	DSA	*dsa;
72	struct KeyCert *cert;
73};
74
75Key		*key_new(int);
76void		 key_add_private(Key *);
77Key		*key_new_private(int);
78void		 key_free(Key *);
79Key		*key_demote(const Key *);
80int		 key_equal_public(const Key *, const Key *);
81int		 key_equal(const Key *, const Key *);
82char		*key_fingerprint(Key *, enum fp_type, enum fp_rep);
83u_char		*key_fingerprint_raw(Key *, enum fp_type, u_int *);
84const char	*key_type(const Key *);
85const char	*key_cert_type(const Key *);
86int		 key_write(const Key *, FILE *);
87int		 key_read(Key *, char **);
88u_int		 key_size(const Key *);
89
90Key	*key_generate(int, u_int);
91Key	*key_from_private(const Key *);
92int	 key_type_from_name(char *);
93int	 key_is_cert(const Key *);
94int	 key_type_plain(int);
95int	 key_to_certified(Key *);
96int	 key_drop_cert(Key *);
97int	 key_certify(Key *, Key *);
98void	 key_cert_copy(const Key *, struct Key *);
99int	 key_cert_check_authority(const Key *, int, int, const char *,
100	    const char **);
101
102Key		*key_from_blob(const u_char *, u_int);
103int		 key_to_blob(const Key *, u_char **, u_int *);
104const char	*key_ssh_name(const Key *);
105int		 key_names_valid2(const char *);
106
107int	 key_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
108int	 key_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
109
110int	 ssh_dss_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
111int	 ssh_dss_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
112int	 ssh_rsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int);
113int	 ssh_rsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int);
114
115#endif
116