blob: 420f592bbfd1111c0a51ea56dcb474e91df756bd [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller4af51302000-04-16 11:18:38 +10002 *
Damien Miller95def091999-11-25 00:26:21 +11003 * authfd.h
Damien Miller4af51302000-04-16 11:18:38 +10004 *
Damien Miller95def091999-11-25 00:26:21 +11005 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Miller95def091999-11-25 00:26:21 +11007 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 * All rights reserved
Damien Miller4af51302000-04-16 11:18:38 +10009 *
Damien Miller95def091999-11-25 00:26:21 +110010 * Created: Wed Mar 29 01:17:41 1995 ylo
Damien Miller4af51302000-04-16 11:18:38 +100011 *
Damien Miller95def091999-11-25 00:26:21 +110012 * Functions to interface with the SSH_AUTHENTICATION_FD socket.
Damien Miller4af51302000-04-16 11:18:38 +100013 *
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Miller4af51302000-04-16 11:18:38 +100016/* RCSID("$Id: authfd.h,v 1.5 2000/04/16 01:18:40 damien Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100017
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
Damien Miller95def091999-11-25 00:26:21 +110034typedef struct {
35 int fd;
36 Buffer packet;
37 Buffer identities;
38 int howmany;
39} AuthenticationConnection;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100040/* Returns the number of the authentication fd, or -1 if there is none. */
Damien Miller95def091999-11-25 00:26:21 +110041int ssh_get_authentication_socket();
Damien Millerd4a8b7e1999-10-27 13:42:43 +100042
Damien Miller5428f641999-11-25 11:54:57 +110043/*
44 * This should be called for any descriptor returned by
45 * ssh_get_authentication_socket(). Depending on the way the descriptor was
46 * obtained, this may close the descriptor.
47 */
Damien Miller95def091999-11-25 00:26:21 +110048void ssh_close_authentication_socket(int authfd);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100049
Damien Miller5428f641999-11-25 11:54:57 +110050/*
51 * Opens and connects a private socket for communication with the
52 * authentication agent. Returns NULL if an error occurred and the
53 * connection could not be opened. The connection should be closed by the
54 * caller by calling ssh_close_authentication_connection().
55 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100056AuthenticationConnection *ssh_get_authentication_connection();
57
Damien Miller5428f641999-11-25 11:54:57 +110058/*
59 * Closes the connection to the authentication agent and frees any associated
60 * memory.
61 */
Damien Miller95def091999-11-25 00:26:21 +110062void ssh_close_authentication_connection(AuthenticationConnection * ac);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100063
Damien Miller5428f641999-11-25 11:54:57 +110064/*
65 * Returns the first authentication identity held by the agent. Returns true
66 * if an identity is available, 0 otherwise. The caller must initialize the
67 * integers before the call, and free the comment after a successful call
68 * (before calling ssh_get_next_identity).
69 */
Damien Miller4af51302000-04-16 11:18:38 +100070int
Damien Miller95def091999-11-25 00:26:21 +110071ssh_get_first_identity(AuthenticationConnection * connection,
72 BIGNUM * e, BIGNUM * n, char **comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100073
Damien Miller5428f641999-11-25 11:54:57 +110074/*
75 * Returns the next authentication identity for the agent. Other functions
76 * can be called between this and ssh_get_first_identity or two calls of this
77 * function. This returns 0 if there are no more identities. The caller
78 * must free comment after a successful return.
79 */
Damien Miller4af51302000-04-16 11:18:38 +100080int
Damien Miller95def091999-11-25 00:26:21 +110081ssh_get_next_identity(AuthenticationConnection * connection,
82 BIGNUM * e, BIGNUM * n, char **comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083
84/* Requests the agent to decrypt the given challenge. Returns true if
85 the agent claims it was able to decrypt it. */
Damien Miller4af51302000-04-16 11:18:38 +100086int
Damien Miller95def091999-11-25 00:26:21 +110087ssh_decrypt_challenge(AuthenticationConnection * auth,
88 BIGNUM * e, BIGNUM * n, BIGNUM * challenge,
89 unsigned char session_id[16],
90 unsigned int response_type,
91 unsigned char response[16]);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100092
Damien Miller5428f641999-11-25 11:54:57 +110093/*
94 * Adds an identity to the authentication server. This call is not meant to
95 * be used by normal applications. This returns true if the identity was
96 * successfully added.
97 */
Damien Miller4af51302000-04-16 11:18:38 +100098int
Damien Miller5428f641999-11-25 11:54:57 +110099ssh_add_identity(AuthenticationConnection * connection, RSA * key,
100 const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000101
Damien Miller5428f641999-11-25 11:54:57 +1100102/*
103 * Removes the identity from the authentication server. This call is not
104 * meant to be used by normal applications. This returns true if the
105 * identity was successfully added.
106 */
107int ssh_remove_identity(AuthenticationConnection * connection, RSA * key);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000108
Damien Miller5428f641999-11-25 11:54:57 +1100109/*
110 * Removes all identities from the authentication agent. This call is not
111 * meant to be used by normal applications. This returns true if the
112 * operation was successful.
113 */
114int ssh_remove_all_identities(AuthenticationConnection * connection);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000115
116/* Closes the connection to the authentication agent. */
Damien Miller5428f641999-11-25 11:54:57 +1100117void ssh_close_authentication(AuthenticationConnection * connection);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000118
Damien Miller95def091999-11-25 00:26:21 +1100119#endif /* AUTHFD_H */