libssh: /build/libssh/src/libssh-0.8.6/include/libssh/pki.h Source File

libssh 0.8.6 The SSH library

pki.h
1 /*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2010 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef PKI_H_
22 #define PKI_H_
23
24 #include "libssh/priv.h"
25 #ifdef HAVE_OPENSSL_EC_H
26 #include <openssl/ec.h>
27 #endif
28 #ifdef HAVE_OPENSSL_ECDSA_H
29 #include <openssl/ecdsa.h>
30 #endif
31
32 #include "libssh/crypto.h"
33 #include "libssh/ed25519.h"
34
35 #define MAX_PUBKEY_SIZE 0x100000 /* 1M */
36 #define MAX_PRIVKEY_SIZE 0x400000 /* 4M */
37
38 #define SSH_KEY_FLAG_EMPTY 0x0
39 #define SSH_KEY_FLAG_PUBLIC 0x0001
40 #define SSH_KEY_FLAG_PRIVATE 0x0002
41
42 struct ssh_key_struct {
43 enum ssh_keytypes_e type;
44 int flags;
45 const char *type_c; /* Don't free it ! it is static */
46 int ecdsa_nid;
47 #ifdef HAVE_LIBGCRYPT
48 gcry_sexp_t dsa;
49 gcry_sexp_t rsa;
50 gcry_sexp_t ecdsa;
51 #elif HAVE_LIBMBEDCRYPTO
52 mbedtls_pk_context *rsa;
53 mbedtls_ecdsa_context *ecdsa;
54 void *dsa;
55 #elif HAVE_LIBCRYPTO
56 DSA *dsa;
57 RSA *rsa;
58 #ifdef HAVE_OPENSSL_ECC
59 EC_KEY *ecdsa;
60 #else
61 void *ecdsa;
62 #endif /* HAVE_OPENSSL_EC_H */
63 #endif
64 ed25519_pubkey *ed25519_pubkey;
65 ed25519_privkey *ed25519_privkey;
66 void *cert;
67 enum ssh_keytypes_e cert_type;
68 };
69
70 struct ssh_signature_struct {
71 enum ssh_keytypes_e type;
72 enum ssh_digest_e hash_type;
73 const char *type_c;
74 #ifdef HAVE_LIBGCRYPT
75 gcry_sexp_t dsa_sig;
76 gcry_sexp_t rsa_sig;
77 gcry_sexp_t ecdsa_sig;
78 #elif defined HAVE_LIBCRYPTO
79 DSA_SIG *dsa_sig;
80 ssh_string rsa_sig;
81 # ifdef HAVE_OPENSSL_ECC
82 ECDSA_SIG *ecdsa_sig;
83 # else
84 void *ecdsa_sig;
85 # endif
86 #elif defined HAVE_LIBMBEDCRYPTO
87 ssh_string rsa_sig;
88 struct mbedtls_ecdsa_sig ecdsa_sig;
89 #endif
90 ed25519_signature *ed25519_sig;
91 };
92
93 typedef struct ssh_signature_struct *ssh_signature;
94
95 /* SSH Key Functions */
96 ssh_key ssh_key_dup(const ssh_key key);
97 void ssh_key_clean (ssh_key key);
98
99 const char *
100 ssh_key_get_signature_algorithm(ssh_session session,
101 enum ssh_keytypes_e type);
102 enum ssh_keytypes_e ssh_key_type_from_signature_name(const char *name);
103
104 /* SSH Signature Functions */
105 ssh_signature ssh_signature_new(void);
106 void ssh_signature_free(ssh_signature sign);
107
108 int ssh_pki_export_signature_blob(const ssh_signature sign,
109 ssh_string *sign_blob);
110 int ssh_pki_import_signature_blob(const ssh_string sig_blob,
111 const ssh_key pubkey,
112 ssh_signature *psig);
113 int ssh_pki_signature_verify(ssh_session session,
114 ssh_signature sig,
115 const ssh_key key,
116 unsigned char *digest,
117 size_t dlen);
118
119 /* SSH Public Key Functions */
120 int ssh_pki_export_pubkey_blob(const ssh_key key,
121 ssh_string *pblob);
122 int ssh_pki_import_pubkey_blob(const ssh_string key_blob,
123 ssh_key *pkey);
124
125 int ssh_pki_import_cert_blob(const ssh_string cert_blob,
126 ssh_key *pkey);
127
128
129 /* SSH Signing Functions */
130 ssh_string ssh_pki_do_sign(ssh_session session, ssh_buffer sigbuf,
131 const ssh_key privatekey);
132 ssh_string ssh_pki_do_sign_agent(ssh_session session,
133 struct ssh_buffer_struct *buf,
134 const ssh_key pubkey);
135 ssh_string ssh_srv_pki_do_sign_sessionid(ssh_session session,
136 const ssh_key privkey);
137
138 /* Temporary functions, to be removed after migration to ssh_key */
139 ssh_public_key ssh_pki_convert_key_to_publickey(const ssh_key key);
140 ssh_private_key ssh_pki_convert_key_to_privatekey(const ssh_key key);
141
142 int ssh_key_algorithm_allowed(ssh_session session, const char *type);
143 #endif /* PKI_H_ */
ssh_key_struct
Definition: pki.h:42
ssh_key_type_from_signature_name
enum ssh_keytypes_e ssh_key_type_from_signature_name(const char *name)
Convert a ssh key algorithm name to a ssh key algorithm type.
Definition: pki.c:362
ssh_session_struct
Definition: session.h:102
ssh_key_get_signature_algorithm
const char * ssh_key_get_signature_algorithm(ssh_session session, enum ssh_keytypes_e type)
Gets signature algorithm name to be used with the given key type.
Definition: pki.c:345
ssh_public_key_struct
Definition: keys.h:28
ssh_string_struct
Definition: string.h:29
ssh_key_clean
void ssh_key_clean(ssh_key key)
clean up the key and deallocate all existing keys
Definition: pki.c:128
ssh_key_algorithm_allowed
int ssh_key_algorithm_allowed(ssh_session session, const char *type)
Checks the given key against the configured allowed public key algorithm types.
Definition: pki.c:284
ssh_signature_struct
Definition: pki.h:70
ssh_private_key_struct
Definition: keys.h:43
ssh_buffer_struct
Definition: buffer.c:47