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