Annotation of src/usr.bin/ssh/authfd.h, Revision 1.9
1.1 deraadt 1: /*
1.7 markus 2: *
1.5 deraadt 3: * authfd.h
1.7 markus 4: *
1.5 deraadt 5: * Author: Tatu Ylonen <ylo@cs.hut.fi>
1.7 markus 6: *
1.5 deraadt 7: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8: * All rights reserved
1.7 markus 9: *
1.5 deraadt 10: * Created: Wed Mar 29 01:17:41 1995 ylo
1.7 markus 11: *
1.5 deraadt 12: * Functions to interface with the SSH_AUTHENTICATION_FD socket.
1.7 markus 13: *
1.5 deraadt 14: */
1.1 deraadt 15:
1.9 ! markus 16: /* RCSID("$OpenBSD: authfd.h,v 1.8 2000/06/20 01:39:38 markus Exp $"); */
1.1 deraadt 17:
18: #ifndef AUTHFD_H
19: #define AUTHFD_H
20:
21: #include "buffer.h"
22:
23: /* Messages for the authentication agent connection. */
24: #define SSH_AGENTC_REQUEST_RSA_IDENTITIES 1
25: #define SSH_AGENT_RSA_IDENTITIES_ANSWER 2
26: #define SSH_AGENTC_RSA_CHALLENGE 3
27: #define SSH_AGENT_RSA_RESPONSE 4
28: #define SSH_AGENT_FAILURE 5
29: #define SSH_AGENT_SUCCESS 6
30: #define SSH_AGENTC_ADD_RSA_IDENTITY 7
31: #define SSH_AGENTC_REMOVE_RSA_IDENTITY 8
32: #define SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES 9
33:
1.9 ! markus 34: #define SSH2_AGENTC_REQUEST_IDENTITIES 11
! 35: #define SSH2_AGENT_IDENTITIES_ANSWER 12
! 36: #define SSH2_AGENTC_SIGN_REQUEST 13
! 37: #define SSH2_AGENT_SIGN_RESPONSE 14
! 38: #define SSH2_AGENT_FAILURE SSH_AGENT_FAILURE
! 39: #define SSH2_AGENT_SUCCESS SSH_AGENT_SUCCESS
! 40: #define SSH2_AGENTC_ADD_IDENTITY 17
! 41: #define SSH2_AGENTC_REMOVE_IDENTITY 18
! 42: #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19
! 43:
1.5 deraadt 44: typedef struct {
45: int fd;
46: Buffer packet;
47: Buffer identities;
48: int howmany;
49: } AuthenticationConnection;
1.1 deraadt 50: /* Returns the number of the authentication fd, or -1 if there is none. */
1.5 deraadt 51: int ssh_get_authentication_socket();
1.1 deraadt 52:
1.6 markus 53: /*
54: * This should be called for any descriptor returned by
55: * ssh_get_authentication_socket(). Depending on the way the descriptor was
56: * obtained, this may close the descriptor.
57: */
1.5 deraadt 58: void ssh_close_authentication_socket(int authfd);
1.1 deraadt 59:
1.6 markus 60: /*
61: * Opens and connects a private socket for communication with the
62: * authentication agent. Returns NULL if an error occurred and the
63: * connection could not be opened. The connection should be closed by the
64: * caller by calling ssh_close_authentication_connection().
65: */
1.1 deraadt 66: AuthenticationConnection *ssh_get_authentication_connection();
67:
1.6 markus 68: /*
69: * Closes the connection to the authentication agent and frees any associated
70: * memory.
71: */
1.5 deraadt 72: void ssh_close_authentication_connection(AuthenticationConnection * ac);
1.1 deraadt 73:
1.6 markus 74: /*
75: * Returns the first authentication identity held by the agent. Returns true
76: * if an identity is available, 0 otherwise. The caller must initialize the
77: * integers before the call, and free the comment after a successful call
78: * (before calling ssh_get_next_identity).
79: */
1.7 markus 80: int
1.5 deraadt 81: ssh_get_first_identity(AuthenticationConnection * connection,
82: BIGNUM * e, BIGNUM * n, char **comment);
1.1 deraadt 83:
1.6 markus 84: /*
85: * Returns the next authentication identity for the agent. Other functions
86: * can be called between this and ssh_get_first_identity or two calls of this
87: * function. This returns 0 if there are no more identities. The caller
88: * must free comment after a successful return.
89: */
1.7 markus 90: int
1.5 deraadt 91: ssh_get_next_identity(AuthenticationConnection * connection,
92: BIGNUM * e, BIGNUM * n, char **comment);
1.1 deraadt 93:
94: /* Requests the agent to decrypt the given challenge. Returns true if
95: the agent claims it was able to decrypt it. */
1.7 markus 96: int
1.5 deraadt 97: ssh_decrypt_challenge(AuthenticationConnection * auth,
98: BIGNUM * e, BIGNUM * n, BIGNUM * challenge,
99: unsigned char session_id[16],
100: unsigned int response_type,
101: unsigned char response[16]);
1.1 deraadt 102:
1.6 markus 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: */
1.7 markus 108: int
1.9 ! markus 109: ssh_add_identity(AuthenticationConnection * connection, Key *key,
1.6 markus 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 * connection, RSA * 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 * connection);
1.1 deraadt 125:
126: /* Closes the connection to the authentication agent. */
1.6 markus 127: void ssh_close_authentication(AuthenticationConnection * connection);
1.1 deraadt 128:
1.5 deraadt 129: #endif /* AUTHFD_H */