authfd.h

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * Functions to interface with the SSH_AUTHENTICATION_FD socket.
   6  *
   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".
  12  */
  13
  14 /* RCSID("$OpenBSD: authfd.h,v 1.17 2001/06/26 04:59:59 markus Exp $"); */
  15
  16 #ifndef AUTHFD_H
  17 #define AUTHFD_H
  18
  19 #include "buffer.h"
  20
  21 /* Messages for the authentication agent connection. */
  22 #define SSH_AGENTC_REQUEST_RSA_IDENTITIES       1
  23 #define SSH_AGENT_RSA_IDENTITIES_ANSWER         2
  24 #define SSH_AGENTC_RSA_CHALLENGE                3
  25 #define SSH_AGENT_RSA_RESPONSE                  4
  26 #define SSH_AGENT_FAILURE                       5
  27 #define SSH_AGENT_SUCCESS                       6
  28 #define SSH_AGENTC_ADD_RSA_IDENTITY             7
  29 #define SSH_AGENTC_REMOVE_RSA_IDENTITY          8
  30 #define SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES    9
  31
  32 /* private OpenSSH extensions for SSH2 */
  33 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
  34 #define SSH2_AGENT_IDENTITIES_ANSWER            12
  35 #define SSH2_AGENTC_SIGN_REQUEST                13
  36 #define SSH2_AGENT_SIGN_RESPONSE                14
  37 #define SSH2_AGENTC_ADD_IDENTITY                17
  38 #define SSH2_AGENTC_REMOVE_IDENTITY             18
  39 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
  40
  41 /* smartcard */
  42 #define SSH_AGENTC_ADD_SMARTCARD_KEY            20
  43 #define SSH_AGENTC_REMOVE_SMARTCARD_KEY         21
  44
  45 /* additional error code for ssh.com's ssh-agent2 */
  46 #define SSH_COM_AGENT2_FAILURE                   102
  47
  48 #define SSH_AGENT_OLD_SIGNATURE                 0x01
  49
  50
  51 typedef struct {
  52         int     fd;
  53         Buffer  identities;
  54         int     howmany;
  55 }       AuthenticationConnection;
  56
  57 /* Returns the number of the authentication fd, or -1 if there is none. */
  58 int     ssh_get_authentication_socket(void);
  59
  60 /*
  61  * This should be called for any descriptor returned by
  62  * ssh_get_authentication_socket().  Depending on the way the descriptor was
  63  * obtained, this may close the descriptor.
  64  */
  65 void    ssh_close_authentication_socket(int authfd);
  66
  67 /*
  68  * Opens and connects a private socket for communication with the
  69  * authentication agent.  Returns NULL if an error occurred and the
  70  * connection could not be opened.  The connection should be closed by the
  71  * caller by calling ssh_close_authentication_connection().
  72  */
  73 AuthenticationConnection *ssh_get_authentication_connection(void);
  74
  75 /*
  76  * Closes the connection to the authentication agent and frees any associated
  77  * memory.
  78  */
  79 void    ssh_close_authentication_connection(AuthenticationConnection *auth);
  80
  81 /*
  82  * Returns the number authentication identity held by the agent.
  83  */
  84 int     ssh_get_num_identities(AuthenticationConnection *auth, int version);
  85
  86 /*
  87  * Returns the first authentication identity held by the agent or NULL if
  88  * no identies are available. Caller must free comment and key.
  89  * Note that you cannot mix calls with different versions.
  90  */
  91 Key     *ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version);
  92
  93 /*
  94  * Returns the next authentication identity for the agent.  Other functions
  95  * can be called between this and ssh_get_first_identity or two calls of this
  96  * function.  This returns NULL if there are no more identities.  The caller
  97  * must free key and comment after a successful return.
  98  */
  99 Key     *ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version);
 100
 101 /*
 102  * Requests the agent to decrypt the given challenge.  Returns true if the
 103  * agent claims it was able to decrypt it.
 104  */
 105 int
 106 ssh_decrypt_challenge(AuthenticationConnection *auth,
 107     Key *key, BIGNUM * challenge,
 108     u_char session_id[16],
 109     u_int response_type,
 110     u_char response[16]);
 111
 112 /* Requests the agent to sign data using key */
 113 int
 114 ssh_agent_sign(AuthenticationConnection *auth,
 115     Key *key,
 116     u_char **sigp, int *lenp,
 117     u_char *data, int datalen);
 118
 119 /*
 120  * Adds an identity to the authentication server.  This call is not meant to
 121  * be used by normal applications.  This returns true if the identity was
 122  * successfully added.
 123  */
 124 int
 125 ssh_add_identity(AuthenticationConnection *auth, Key *key,
 126     const char *comment);
 127
 128 /*
 129  * Removes the identity from the authentication server.  This call is not
 130  * meant to be used by normal applications.  This returns true if the
 131  * identity was successfully added.
 132  */
 133 int     ssh_remove_identity(AuthenticationConnection *auth, Key *key);
 134
 135 /*
 136  * Removes all identities from the authentication agent.  This call is not
 137  * meant to be used by normal applications.  This returns true if the
 138  * operation was successful.
 139  */
 140 int     ssh_remove_all_identities(AuthenticationConnection *auth, int version);
 141
 142 int     ssh_update_card(AuthenticationConnection *auth, int add, int reader_id);
 143
 144 #endif                          /* AUTHFD_H */