2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * Functions for connecting the local authentication agent.
7 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
13 * SSH2 implementation,
14 * Copyright (c) 2000 Markus Friedl. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 RCSID("$OpenBSD: authfd.c,v 1.63 2003/11/21 11:57:03 djm Exp $");
40 #include <openssl/evp.h>
56 static int agent_present = 0;
59 int decode_reply(int type);
61 /* macro to check for "agent failure" message */
62 #define agent_failed(x) \
63 ((x == SSH_AGENT_FAILURE) || (x == SSH_COM_AGENT2_FAILURE) || \
64 (x == SSH2_AGENT_FAILURE))
67 ssh_agent_present(void)
73 if ((authfd = ssh_get_authentication_socket()) == -1)
76 ssh_close_authentication_socket(authfd);
81 /* Returns the number of the authentication fd, or -1 if there is none. */
84 ssh_get_authentication_socket(void)
86 const char *authsocket;
88 struct sockaddr_un sunaddr;
90 authsocket = getenv(SSH_AUTHSOCKET_ENV_NAME);
94 sunaddr.sun_family = AF_UNIX;
95 strlcpy(sunaddr.sun_path, authsocket, sizeof(sunaddr.sun_path));
97 sock = socket(AF_UNIX, SOCK_STREAM, 0);
102 if (fcntl(sock, F_SETFD, 1) == -1) {
106 if (connect(sock, (struct sockaddr *) &sunaddr, sizeof sunaddr) < 0) {
115 ssh_request_reply(AuthenticationConnection *auth, Buffer *request, Buffer *reply)
121 /* Get the length of the message, and format it in the buffer. */
122 len = buffer_len(request);
125 /* Send the length and then the packet to the agent. */
126 if (atomicio(vwrite, auth->fd, buf, 4) != 4 ||
127 atomicio(vwrite, auth->fd, buffer_ptr(request),
128 buffer_len(request)) != buffer_len(request)) {
129 error("Error writing to authentication socket.");
133 * Wait for response from the agent. First read the length of the
138 l = read(auth->fd, buf + 4 - len, len);
139 if (l == -1 && (errno == EAGAIN || errno == EINTR))
142 error("Error reading response length from authentication socket.");
148 /* Extract the length, and check it for sanity. */
149 len = GET_32BIT(buf);
150 if (len > 256 * 1024)
151 fatal("Authentication response too long: %u", len);
153 /* Read the rest of the response in to the buffer. */
159 l = read(auth->fd, buf, l);
160 if (l == -1 && (errno == EAGAIN || errno == EINTR))
163 error("Error reading response from authentication socket.");
166 buffer_append(reply, buf, l);
173 * Closes the agent socket if it should be closed (depends on how it was
174 * obtained). The argument must have been returned by
175 * ssh_get_authentication_socket().
179 ssh_close_authentication_socket(int sock)
181 if (getenv(SSH_AUTHSOCKET_ENV_NAME))
186 * Opens and connects a private socket for communication with the
187 * authentication agent. Returns the file descriptor (which must be
188 * shut down and closed by the caller when no longer needed).
189 * Returns NULL if an error occurred and the connection could not be
193 AuthenticationConnection *
194 ssh_get_authentication_connection(void)
196 AuthenticationConnection *auth;
199 sock = ssh_get_authentication_socket();
202 * Fail if we couldn't obtain a connection. This happens if we
203 * exited due to a timeout.
208 auth = xmalloc(sizeof(*auth));
210 buffer_init(&auth->identities);
217 * Closes the connection to the authentication agent and frees any associated
222 ssh_close_authentication_connection(AuthenticationConnection *auth)
224 buffer_free(&auth->identities);
229 /* Lock/unlock agent */
231 ssh_lock_agent(AuthenticationConnection *auth, int lock, const char *password)
237 buffer_put_char(&msg, lock ? SSH_AGENTC_LOCK : SSH_AGENTC_UNLOCK);
238 buffer_put_cstring(&msg, password);
240 if (ssh_request_reply(auth, &msg, &msg) == 0) {
244 type = buffer_get_char(&msg);
246 return decode_reply(type);
250 * Returns the first authentication identity held by the agent.
254 ssh_get_num_identities(AuthenticationConnection *auth, int version)
256 int type, code1 = 0, code2 = 0;
261 code1 = SSH_AGENTC_REQUEST_RSA_IDENTITIES;
262 code2 = SSH_AGENT_RSA_IDENTITIES_ANSWER;
265 code1 = SSH2_AGENTC_REQUEST_IDENTITIES;
266 code2 = SSH2_AGENT_IDENTITIES_ANSWER;
273 * Send a message to the agent requesting for a list of the
274 * identities it can represent.
276 buffer_init(&request);
277 buffer_put_char(&request, code1);
279 buffer_clear(&auth->identities);
280 if (ssh_request_reply(auth, &request, &auth->identities) == 0) {
281 buffer_free(&request);
284 buffer_free(&request);
286 /* Get message type, and verify that we got a proper answer. */
287 type = buffer_get_char(&auth->identities);
288 if (agent_failed(type)) {
290 } else if (type != code2) {
291 fatal("Bad authentication reply message type: %d", type);
294 /* Get the number of entries in the response and check it for sanity. */
295 auth->howmany = buffer_get_int(&auth->identities);
296 if ((u_int)auth->howmany > 1024)
297 fatal("Too many identities in authentication reply: %d",
300 return auth->howmany;
304 ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version)
306 /* get number of identities and return the first entry (if any). */
307 if (ssh_get_num_identities(auth, version) > 0)
308 return ssh_get_next_identity(auth, comment, version);
313 ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version)
320 /* Return failure if no more entries. */
321 if (auth->howmany <= 0)
325 * Get the next entry from the packet. These will abort with a fatal
326 * error if the packet is too short or contains corrupt data.
330 key = key_new(KEY_RSA1);
331 bits = buffer_get_int(&auth->identities);
332 buffer_get_bignum(&auth->identities, key->rsa->e);
333 buffer_get_bignum(&auth->identities, key->rsa->n);
334 *comment = buffer_get_string(&auth->identities, NULL);
335 if (bits != BN_num_bits(key->rsa->n))
336 logit("Warning: identity keysize mismatch: actual %d, announced %u",
337 BN_num_bits(key->rsa->n), bits);
340 blob = buffer_get_string(&auth->identities, &blen);
341 *comment = buffer_get_string(&auth->identities, NULL);
342 key = key_from_blob(blob, blen);
349 /* Decrement the number of remaining entries. */
355 * Generates a random challenge, sends it to the agent, and waits for
356 * response from the agent. Returns true (non-zero) if the agent gave the
357 * correct answer, zero otherwise. Response type selects the style of
358 * response desired, with 0 corresponding to protocol version 1.0 (no longer
359 * supported) and 1 corresponding to protocol version 1.1.
363 ssh_decrypt_challenge(AuthenticationConnection *auth,
364 Key* key, BIGNUM *challenge,
365 u_char session_id[16],
374 if (key->type != KEY_RSA1)
376 if (response_type == 0) {
377 logit("Compatibility with ssh protocol version 1.0 no longer supported.");
380 buffer_init(&buffer);
381 buffer_put_char(&buffer, SSH_AGENTC_RSA_CHALLENGE);
382 buffer_put_int(&buffer, BN_num_bits(key->rsa->n));
383 buffer_put_bignum(&buffer, key->rsa->e);
384 buffer_put_bignum(&buffer, key->rsa->n);
385 buffer_put_bignum(&buffer, challenge);
386 buffer_append(&buffer, session_id, 16);
387 buffer_put_int(&buffer, response_type);
389 if (ssh_request_reply(auth, &buffer, &buffer) == 0) {
390 buffer_free(&buffer);
393 type = buffer_get_char(&buffer);
395 if (agent_failed(type)) {
396 logit("Agent admitted failure to authenticate using the key.");
397 } else if (type != SSH_AGENT_RSA_RESPONSE) {
398 fatal("Bad authentication response: %d", type);
402 * Get the response from the packet. This will abort with a
403 * fatal error if the packet is corrupt.
405 for (i = 0; i < 16; i++)
406 response[i] = buffer_get_char(&buffer);
408 buffer_free(&buffer);
412 /* ask agent to sign data, returns -1 on error, 0 on success */
414 ssh_agent_sign(AuthenticationConnection *auth,
416 u_char **sigp, u_int *lenp,
417 u_char *data, u_int datalen)
419 extern int datafellows;
426 if (key_to_blob(key, &blob, &blen) == 0)
429 if (datafellows & SSH_BUG_SIGBLOB)
430 flags = SSH_AGENT_OLD_SIGNATURE;
433 buffer_put_char(&msg, SSH2_AGENTC_SIGN_REQUEST);
434 buffer_put_string(&msg, blob, blen);
435 buffer_put_string(&msg, data, datalen);
436 buffer_put_int(&msg, flags);
439 if (ssh_request_reply(auth, &msg, &msg) == 0) {
443 type = buffer_get_char(&msg);
444 if (agent_failed(type)) {
445 logit("Agent admitted failure to sign using the key.");
446 } else if (type != SSH2_AGENT_SIGN_RESPONSE) {
447 fatal("Bad authentication response: %d", type);
450 *sigp = buffer_get_string(&msg, lenp);
456 /* Encode key for a message to the agent. */
459 ssh_encode_identity_rsa1(Buffer *b, RSA *key, const char *comment)
461 buffer_put_int(b, BN_num_bits(key->n));
462 buffer_put_bignum(b, key->n);
463 buffer_put_bignum(b, key->e);
464 buffer_put_bignum(b, key->d);
465 /* To keep within the protocol: p < q for ssh. in SSL p > q */
466 buffer_put_bignum(b, key->iqmp); /* ssh key->u */
467 buffer_put_bignum(b, key->q); /* ssh key->p, SSL key->q */
468 buffer_put_bignum(b, key->p); /* ssh key->q, SSL key->p */
469 buffer_put_cstring(b, comment);
473 ssh_encode_identity_ssh2(Buffer *b, Key *key, const char *comment)
475 buffer_put_cstring(b, key_ssh_name(key));
478 buffer_put_bignum2(b, key->rsa->n);
479 buffer_put_bignum2(b, key->rsa->e);
480 buffer_put_bignum2(b, key->rsa->d);
481 buffer_put_bignum2(b, key->rsa->iqmp);
482 buffer_put_bignum2(b, key->rsa->p);
483 buffer_put_bignum2(b, key->rsa->q);
486 buffer_put_bignum2(b, key->dsa->p);
487 buffer_put_bignum2(b, key->dsa->q);
488 buffer_put_bignum2(b, key->dsa->g);
489 buffer_put_bignum2(b, key->dsa->pub_key);
490 buffer_put_bignum2(b, key->dsa->priv_key);
493 buffer_put_cstring(b, comment);
497 * Adds an identity to the authentication server. This call is not meant to
498 * be used by normal applications.
502 ssh_add_identity_constrained(AuthenticationConnection *auth, Key *key,
503 const char *comment, u_int life, u_int confirm)
506 int type, constrained = (life || confirm);
513 SSH_AGENTC_ADD_RSA_ID_CONSTRAINED :
514 SSH_AGENTC_ADD_RSA_IDENTITY;
515 buffer_put_char(&msg, type);
516 ssh_encode_identity_rsa1(&msg, key->rsa, comment);
521 SSH2_AGENTC_ADD_ID_CONSTRAINED :
522 SSH2_AGENTC_ADD_IDENTITY;
523 buffer_put_char(&msg, type);
524 ssh_encode_identity_ssh2(&msg, key, comment);
533 buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
534 buffer_put_int(&msg, life);
537 buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
539 if (ssh_request_reply(auth, &msg, &msg) == 0) {
543 type = buffer_get_char(&msg);
545 return decode_reply(type);
549 ssh_add_identity(AuthenticationConnection *auth, Key *key, const char *comment)
551 return ssh_add_identity_constrained(auth, key, comment, 0, 0);
555 * Removes an identity from the authentication server. This call is not
556 * meant to be used by normal applications.
560 ssh_remove_identity(AuthenticationConnection *auth, Key *key)
569 if (key->type == KEY_RSA1) {
570 buffer_put_char(&msg, SSH_AGENTC_REMOVE_RSA_IDENTITY);
571 buffer_put_int(&msg, BN_num_bits(key->rsa->n));
572 buffer_put_bignum(&msg, key->rsa->e);
573 buffer_put_bignum(&msg, key->rsa->n);
574 } else if (key->type == KEY_DSA || key->type == KEY_RSA) {
575 key_to_blob(key, &blob, &blen);
576 buffer_put_char(&msg, SSH2_AGENTC_REMOVE_IDENTITY);
577 buffer_put_string(&msg, blob, blen);
583 if (ssh_request_reply(auth, &msg, &msg) == 0) {
587 type = buffer_get_char(&msg);
589 return decode_reply(type);
593 ssh_update_card(AuthenticationConnection *auth, int add,
594 const char *reader_id, const char *pin, u_int life, u_int confirm)
597 int type, constrained = (life || confirm);
601 SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED :
602 SSH_AGENTC_ADD_SMARTCARD_KEY;
604 type = SSH_AGENTC_REMOVE_SMARTCARD_KEY;
607 buffer_put_char(&msg, type);
608 buffer_put_cstring(&msg, reader_id);
609 buffer_put_cstring(&msg, pin);
613 buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_LIFETIME);
614 buffer_put_int(&msg, life);
617 buffer_put_char(&msg, SSH_AGENT_CONSTRAIN_CONFIRM);
620 if (ssh_request_reply(auth, &msg, &msg) == 0) {
624 type = buffer_get_char(&msg);
626 return decode_reply(type);
630 * Removes all identities from the agent. This call is not meant to be used
631 * by normal applications.
635 ssh_remove_all_identities(AuthenticationConnection *auth, int version)
639 int code = (version==1) ?
640 SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES :
641 SSH2_AGENTC_REMOVE_ALL_IDENTITIES;
644 buffer_put_char(&msg, code);
646 if (ssh_request_reply(auth, &msg, &msg) == 0) {
650 type = buffer_get_char(&msg);
652 return decode_reply(type);
656 decode_reply(int type)
659 case SSH_AGENT_FAILURE:
660 case SSH_COM_AGENT2_FAILURE:
661 case SSH2_AGENT_FAILURE:
662 logit("SSH_AGENT_FAILURE");
664 case SSH_AGENT_SUCCESS:
667 fatal("Bad response from authentication agent: %d", type);