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