blob: b7a137d99d381909e0f1bed9e48a192d6819ba8e [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11005 * Functions to interface with the SSH_AUTHENTICATION_FD socket.
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Millere4340be2000-09-16 13:29:08 +11007 * 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".
Damien Miller95def091999-11-25 00:26:21 +110012 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100013
Damien Millere4340be2000-09-16 13:29:08 +110014/* RCSID("$OpenBSD: authfd.h,v 1.11 2000/09/07 20:27:49 deraadt Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
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
Damien Miller994cf142000-07-21 10:19:44 +100032#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
Damien Miller994cf142000-07-21 10:19:44 +100036#define SSH2_AGENTC_ADD_IDENTITY 17
37#define SSH2_AGENTC_REMOVE_IDENTITY 18
38#define SSH2_AGENTC_REMOVE_ALL_IDENTITIES 19
39
Damien Miller95def091999-11-25 00:26:21 +110040typedef struct {
41 int fd;
Damien Miller95def091999-11-25 00:26:21 +110042 Buffer identities;
43 int howmany;
44} AuthenticationConnection;
Damien Millerad833b32000-08-23 10:46:23 +100045
Damien Millerd4a8b7e1999-10-27 13:42:43 +100046/* Returns the number of the authentication fd, or -1 if there is none. */
Damien Miller95def091999-11-25 00:26:21 +110047int ssh_get_authentication_socket();
Damien Millerd4a8b7e1999-10-27 13:42:43 +100048
Damien Miller5428f641999-11-25 11:54:57 +110049/*
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 */
Damien Miller95def091999-11-25 00:26:21 +110054void ssh_close_authentication_socket(int authfd);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100055
Damien Miller5428f641999-11-25 11:54:57 +110056/*
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 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100062AuthenticationConnection *ssh_get_authentication_connection();
63
Damien Miller5428f641999-11-25 11:54:57 +110064/*
65 * Closes the connection to the authentication agent and frees any associated
66 * memory.
67 */
Damien Millerad833b32000-08-23 10:46:23 +100068void ssh_close_authentication_connection(AuthenticationConnection *auth);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100069
Damien Miller5428f641999-11-25 11:54:57 +110070/*
Damien Millerad833b32000-08-23 10:46:23 +100071 * 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.
Damien Miller5428f641999-11-25 11:54:57 +110074 */
Damien Millerad833b32000-08-23 10:46:23 +100075Key *ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100076
Damien Miller5428f641999-11-25 11:54:57 +110077/*
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
Damien Millerad833b32000-08-23 10:46:23 +100080 * function. This returns NULL if there are no more identities. The caller
81 * must free key and comment after a successful return.
82 */
83Key *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.
Damien Miller5428f641999-11-25 11:54:57 +110088 */
Damien Miller4af51302000-04-16 11:18:38 +100089int
Damien Millerad833b32000-08-23 10:46:23 +100090ssh_decrypt_challenge(AuthenticationConnection *auth,
91 Key *key, BIGNUM * challenge,
Damien Miller95def091999-11-25 00:26:21 +110092 unsigned char session_id[16],
93 unsigned int response_type,
94 unsigned char response[16]);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100095
Damien Millerad833b32000-08-23 10:46:23 +100096/* Requests the agent to sign data using key */
97int
98ssh_agent_sign(AuthenticationConnection *auth,
99 Key *key,
100 unsigned char **sigp, int *lenp,
101 unsigned char *data, int datalen);
102
Damien Miller5428f641999-11-25 11:54:57 +1100103/*
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 */
Damien Miller4af51302000-04-16 11:18:38 +1000108int
Damien Millerad833b32000-08-23 10:46:23 +1000109ssh_add_identity(AuthenticationConnection *auth, Key *key,
Damien Miller5428f641999-11-25 11:54:57 +1100110 const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000111
Damien Miller5428f641999-11-25 11:54:57 +1100112/*
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 */
Damien Millerad833b32000-08-23 10:46:23 +1000117int ssh_remove_identity(AuthenticationConnection *auth, Key *key);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000118
Damien Miller5428f641999-11-25 11:54:57 +1100119/*
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 */
Damien Millerad833b32000-08-23 10:46:23 +1000124int ssh_remove_all_identities(AuthenticationConnection *auth, int version);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000125
Damien Miller95def091999-11-25 00:26:21 +1100126#endif /* AUTHFD_H */