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.11 2000/09/07 20:27:49 deraadt 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 #define SSH2_AGENTC_REQUEST_IDENTITIES          11
  33 #define SSH2_AGENT_IDENTITIES_ANSWER            12
  34 #define SSH2_AGENTC_SIGN_REQUEST                13
  35 #define SSH2_AGENT_SIGN_RESPONSE                14
  36 #define SSH2_AGENTC_ADD_IDENTITY                17
  37 #define SSH2_AGENTC_REMOVE_IDENTITY             18
  38 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES       19
  39
  40 typedef struct {
  41         int     fd;
  42         Buffer  identities;
  43         int     howmany;
  44 }       AuthenticationConnection;
  45
  46 /* Returns the number of the authentication fd, or -1 if there is none. */
  47 int     ssh_get_authentication_socket();
  48
  49 /*
  50  * This should be called for any descriptor returned by
  51  * ssh_get_authentication_socket().  Depending on the way the descriptor was
  52  * obtained, this may close the descriptor.
  53  */
  54 void    ssh_close_authentication_socket(int authfd);
  55
  56 /*
  57  * Opens and connects a private socket for communication with the
  58  * authentication agent.  Returns NULL if an error occurred and the
  59  * connection could not be opened.  The connection should be closed by the
  60  * caller by calling ssh_close_authentication_connection().
  61  */
  62 AuthenticationConnection *ssh_get_authentication_connection();
  63
  64 /*
  65  * Closes the connection to the authentication agent and frees any associated
  66  * memory.
  67  */
  68 void    ssh_close_authentication_connection(AuthenticationConnection *auth);
  69
  70 /*
  71  * Returns the first authentication identity held by the agent or NULL if
  72  * no identies are available. Caller must free comment and key.
  73  * Note that you cannot mix calls with different versions.
  74  */
  75 Key     *ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version);
  76
  77 /*
  78  * Returns the next authentication identity for the agent.  Other functions
  79  * can be called between this and ssh_get_first_identity or two calls of this
  80  * function.  This returns NULL if there are no more identities.  The caller
  81  * must free key and comment after a successful return.
  82  */
  83 Key     *ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version);
  84
  85 /*
  86  * Requests the agent to decrypt the given challenge.  Returns true if the
  87  * agent claims it was able to decrypt it.
  88  */
  89 int
  90 ssh_decrypt_challenge(AuthenticationConnection *auth,
  91     Key *key, BIGNUM * challenge,
  92     unsigned char session_id[16],
  93     unsigned int response_type,
  94     unsigned char response[16]);
  95
  96 /* Requests the agent to sign data using key */
  97 int
  98 ssh_agent_sign(AuthenticationConnection *auth,
  99     Key *key,
 100     unsigned char **sigp, int *lenp,
 101     unsigned char *data, int datalen);
 102
 103 /*
 104  * Adds an identity to the authentication server.  This call is not meant to
 105  * be used by normal applications.  This returns true if the identity was
 106  * successfully added.
 107  */
 108 int
 109 ssh_add_identity(AuthenticationConnection *auth, Key *key,
 110     const char *comment);
 111
 112 /*
 113  * Removes the identity from the authentication server.  This call is not
 114  * meant to be used by normal applications.  This returns true if the
 115  * identity was successfully added.
 116  */
 117 int     ssh_remove_identity(AuthenticationConnection *auth, Key *key);
 118
 119 /*
 120  * Removes all identities from the authentication agent.  This call is not
 121  * meant to be used by normal applications.  This returns true if the
 122  * operation was successful.
 123  */
 124 int     ssh_remove_all_identities(AuthenticationConnection *auth, int version);
 125
 126 #endif                          /* AUTHFD_H */