1 /* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file crypt_common.c Crypto functions independent of openssl/libgcrypt. */
11 #include "crypt_backend.h"
12 #include "portable_io.h"
16 /** If the key begins with this text, we treat it as an ssh key. */
17 #define KEY_TYPE_TXT "ssh-rsa"
20 * Check if the given buffer starts with an ssh rsa key signature.
22 * Returns number of header bytes to be skipped on success, zero if no ssh rsa
23 * signature was found.
25 static size_t is_ssh_rsa_key(char *data, size_t size)
29 if (size < strlen(KEY_TYPE_TXT) + 2)
31 cp = memchr(data, ' ', size);
34 if (strncmp(KEY_TYPE_TXT, data, strlen(KEY_TYPE_TXT)))
37 if (cp >= data + size)
45 * Perform some sanity checks on the decoded ssh key.
47 * This function returns the size of the header. Usually, the header is 11
48 * bytes long: four bytes for the length field, and the string "ssh-rsa".
50 static int check_ssh_key_header(const unsigned char *blob, int blen)
52 const unsigned char *p = blob, *end = blob + blen;
56 return -E_SSH_KEY_HEADER;
57 rlen = read_u32_be(p);
60 return -E_SSH_KEY_HEADER;
62 return -E_SSH_KEY_HEADER;
63 if (rlen < strlen(KEY_TYPE_TXT))
64 return -E_SSH_KEY_HEADER;
65 PARA_DEBUG_LOG("type: %s, rlen: %u\n", p, rlen);
66 if (strncmp((char *)p, KEY_TYPE_TXT, strlen(KEY_TYPE_TXT)))
67 return -E_SSH_KEY_HEADER;
72 * Perform sanity checks and base64-decode an ssh-rsa key.
74 * \param filename The public key file (usually id_rsa.pub).
75 * \param blob Pointer to base64-decoded blob is returned here.
76 * \param decoded_size The size of the decoded blob.
78 * The memory pointed at by the returned blob pointer has to be freed by the
81 * \return On success, the offset in bytes of the start of the key values
82 * (modulus, exponent..). This is the number of bytes to skip from the blob
83 * until the start of the first encoded number. On failure, a negative error
86 * \sa \ref uudecode().
88 int decode_public_key(const char *filename, unsigned char **blob,
95 ret = mmap_full_file(filename, O_RDONLY, &map, &map_size, NULL);
98 ret = is_ssh_rsa_key(map, map_size);
103 ret = uudecode(map + ret, map_size - ret, (char **)blob, decoded_size);
106 ret = check_ssh_key_header(*blob, *decoded_size);
110 ret2 = para_munmap(map, map_size);
111 if (ret >= 0 && ret2 < 0)
117 * Check existence and permissions of a private key file.
119 * \param file The path of the key file.
121 * This checks whether the file exists and its permissions are restrictive
122 * enough. It is considered an error if we own the file and it is readable for
127 int check_private_key_file(const char *file)
131 if (stat(file, &st) != 0)
132 return -ERRNO_TO_PARA_ERROR(errno);
133 if ((st.st_uid == getuid()) && (st.st_mode & 077) != 0)
138 void hash_to_asc(const unsigned char *hash, char *asc)
141 const char hexchar[] = "0123456789abcdef";
143 for (i = 0; i < HASH_SIZE; i++) {
144 asc[2 * i] = hexchar[hash[i] >> 4];
145 asc[2 * i + 1] = hexchar[hash[i] & 0xf];
147 asc[2 * HASH_SIZE] = '\0';
150 int hash_compare(const unsigned char *h1, const unsigned char *h2)
154 for (i = 0; i < HASH_SIZE; i++) {
163 void hash2_to_asc(const unsigned char *hash, char *asc)
166 const char hexchar[] = "0123456789abcdef";
168 for (i = 0; i < HASH2_SIZE; i++) {
169 asc[2 * i] = hexchar[hash[i] >> 4];
170 asc[2 * i + 1] = hexchar[hash[i] & 0xf];
172 asc[2 * HASH2_SIZE] = '\0';
175 int hash2_compare(const unsigned char *h1, const unsigned char *h2)
179 for (i = 0; i < HASH2_SIZE; i++) {
189 * Check header of an openssh private key and compute bignum offset.
191 * \param data The base64-decoded key.
192 * \param len The size of the decoded key.
194 * Several assumptions are made about the key. Most notably, we only support
195 * single unencrypted keys without comments.
197 * \return The offset at which the first bignum of the private key (the public
198 * exponent n) starts. Negative error code on failure.
200 int find_openssh_bignum_offset(const unsigned char *data, int len)
203 * Unencrypted keys without comments always start with the below byte
204 * sequence. See PROTOCOL.key of the openssh package.
206 static const unsigned char valid_openssh_header[] = {
207 /* string "openssh-key-v1" */
208 0x6f, 0x70, 0x65, 0x6e, 0x73, 0x73, 0x68, 0x2d, 0x6b, 0x65,
209 0x79, 0x2d, 0x76, 0x31,
210 /* length of the cipher name */
211 0x00, 0x00, 0x00, 0x00, 0x04,
212 /* cipher name: "none" */
213 0x6e, 0x6f, 0x6e, 0x65,
214 /* length of the kdfname (only used for encrypted keys) */
215 0x00, 0x00, 0x00, 0x04,
216 /* kdfname: "none" */
217 0x6e, 0x6f, 0x6e, 0x65,
218 /* length of kdfoptions */
219 0x00, 0x00, 0x00, 0x00,
221 0x00, 0x00, 0x00, 0x01,
224 const unsigned char *p, *end = data + len;
226 if (len <= sizeof(valid_openssh_header) + 4)
227 return -E_OPENSSH_PARSE;
228 if (memcmp(data, valid_openssh_header, sizeof(valid_openssh_header)))
229 return -E_OPENSSH_PARSE;
230 p = data + sizeof(valid_openssh_header);
231 /* length of public key */
232 val = read_u32_be(p);
233 if (val > end - p - 4)
234 return -E_OPENSSH_PARSE;
236 /* length of private key */
237 val = read_u32_be(p);
238 if (val > end - p - 4)
239 return -E_OPENSSH_PARSE;
241 /* two equal random integers ("checkint") */
243 return -E_OPENSSH_PARSE;
244 if (read_u32_be(p) != read_u32_be(p + 4))
245 return -E_OPENSSH_PARSE;
247 /* length of name of key type "ssh-rsa" */
249 return -E_OPENSSH_PARSE;
250 if (read_u32_be(p) != 7)
251 return -E_OPENSSH_PARSE;
252 if (memcmp(p + 4, "ssh-rsa", 7))
253 return -E_OPENSSH_PARSE;
258 /** Private PEM keys (legacy format) start with this header. */
259 #define PRIVATE_PEM_KEY_HEADER "-----BEGIN RSA PRIVATE KEY-----"
260 /** Private OPENSSH keys (RFC4716) start with this header. */
261 #define PRIVATE_OPENSSH_KEY_HEADER "-----BEGIN OPENSSH PRIVATE KEY-----"
262 /** Private PEM keys (legacy format) end with this footer. */
263 #define PRIVATE_PEM_KEY_FOOTER "-----END RSA PRIVATE KEY-----"
264 /** Private OPENSSH keys (RFC4716) end with this footer. */
265 #define PRIVATE_OPENSSH_KEY_FOOTER "-----END OPENSSH PRIVATE KEY-----"
268 * Decode an openssh-v1 (aka RFC4716) or PEM (aka ASN.1) private key.
270 * \param key_file The private key file (usually id_rsa).
271 * \param result Pointer to base64-decoded blob is returned here.
272 * \param blob_size The size of the decoded blob.
274 * This only checks header and footer and base64-decodes the part in between.
275 * No attempt to read the decoded part is made.
277 * \return Negative on errors, PKT_PEM or PKT_OPENSSH on success, indicating
280 int decode_private_key(const char *key_file, unsigned char **result,
283 int ret, ret2, i, j, key_type;
285 size_t map_size, key_size;
286 unsigned char *blob = NULL;
287 char *begin, *footer, *key;
289 ret = mmap_full_file(key_file, O_RDONLY, &map, &map_size, NULL);
293 if (strncmp(map, PRIVATE_PEM_KEY_HEADER,
294 strlen(PRIVATE_PEM_KEY_HEADER)) == 0) {
296 begin = map + strlen(PRIVATE_PEM_KEY_HEADER);
297 footer = strstr(map, PRIVATE_PEM_KEY_FOOTER);
298 PARA_INFO_LOG("detected legacy PEM key %s\n", key_file);
299 } else if (strncmp(map, PRIVATE_OPENSSH_KEY_HEADER,
300 strlen(PRIVATE_OPENSSH_KEY_HEADER)) == 0) {
301 key_type = PKT_OPENSSH;
302 begin = map + strlen(PRIVATE_OPENSSH_KEY_HEADER);
303 footer = strstr(map, PRIVATE_OPENSSH_KEY_FOOTER);
304 PARA_INFO_LOG("detected openssh key %s\n", key_file);
309 /* skip whitespace at the beginning */
310 for (; begin < footer; begin++) {
311 if (para_isspace(*begin))
319 key_size = footer - begin;
320 key = alloc(key_size + 1);
321 for (i = 0, j = 0; begin + i < footer; i++) {
322 if (para_isspace(begin[i]))
327 ret = base64_decode(key, j, (char **)&blob, blob_size);
333 ret2 = para_munmap(map, map_size);
334 if (ret >= 0 && ret2 < 0)