blob: 808575cd8b26845247fa1952b2325cda3e17f44b [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 Miller62cee002000-09-23 17:15:56 +110014/* RCSID("$OpenBSD: authfd.h,v 1.12 2000/09/21 11:07:51 markus 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 Miller62cee002000-09-23 17:15:56 +110040#define SSH_AGENT_OLD_SIGNATURE 0x01
41
42
Damien Miller95def091999-11-25 00:26:21 +110043typedef struct {
44 int fd;
Damien Miller95def091999-11-25 00:26:21 +110045 Buffer identities;
46 int howmany;
47} AuthenticationConnection;
Damien Millerad833b32000-08-23 10:46:23 +100048
Damien Millerd4a8b7e1999-10-27 13:42:43 +100049/* Returns the number of the authentication fd, or -1 if there is none. */
Damien Miller95def091999-11-25 00:26:21 +110050int ssh_get_authentication_socket();
Damien Millerd4a8b7e1999-10-27 13:42:43 +100051
Damien Miller5428f641999-11-25 11:54:57 +110052/*
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 */
Damien Miller95def091999-11-25 00:26:21 +110057void ssh_close_authentication_socket(int authfd);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100058
Damien Miller5428f641999-11-25 11:54:57 +110059/*
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 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065AuthenticationConnection *ssh_get_authentication_connection();
66
Damien Miller5428f641999-11-25 11:54:57 +110067/*
68 * Closes the connection to the authentication agent and frees any associated
69 * memory.
70 */
Damien Millerad833b32000-08-23 10:46:23 +100071void ssh_close_authentication_connection(AuthenticationConnection *auth);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100072
Damien Miller5428f641999-11-25 11:54:57 +110073/*
Damien Millerad833b32000-08-23 10:46:23 +100074 * 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.
Damien Miller5428f641999-11-25 11:54:57 +110077 */
Damien Millerad833b32000-08-23 10:46:23 +100078Key *ssh_get_first_identity(AuthenticationConnection *auth, char **comment, int version);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100079
Damien Miller5428f641999-11-25 11:54:57 +110080/*
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
Damien Millerad833b32000-08-23 10:46:23 +100083 * function. This returns NULL if there are no more identities. The caller
84 * must free key and comment after a successful return.
85 */
86Key *ssh_get_next_identity(AuthenticationConnection *auth, char **comment, int version);
87
88/*
89 * Requests the agent to decrypt the given challenge. Returns true if the
90 * agent claims it was able to decrypt it.
Damien Miller5428f641999-11-25 11:54:57 +110091 */
Damien Miller4af51302000-04-16 11:18:38 +100092int
Damien Millerad833b32000-08-23 10:46:23 +100093ssh_decrypt_challenge(AuthenticationConnection *auth,
94 Key *key, BIGNUM * challenge,
Damien Miller95def091999-11-25 00:26:21 +110095 unsigned char session_id[16],
96 unsigned int response_type,
97 unsigned char response[16]);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100098
Damien Millerad833b32000-08-23 10:46:23 +100099/* Requests the agent to sign data using key */
100int
101ssh_agent_sign(AuthenticationConnection *auth,
102 Key *key,
103 unsigned char **sigp, int *lenp,
104 unsigned char *data, int datalen);
105
Damien Miller5428f641999-11-25 11:54:57 +1100106/*
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 */
Damien Miller4af51302000-04-16 11:18:38 +1000111int
Damien Millerad833b32000-08-23 10:46:23 +1000112ssh_add_identity(AuthenticationConnection *auth, Key *key,
Damien Miller5428f641999-11-25 11:54:57 +1100113 const char *comment);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000114
Damien Miller5428f641999-11-25 11:54:57 +1100115/*
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 */
Damien Millerad833b32000-08-23 10:46:23 +1000120int ssh_remove_identity(AuthenticationConnection *auth, Key *key);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000121
Damien Miller5428f641999-11-25 11:54:57 +1100122/*
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 */
Damien Millerad833b32000-08-23 10:46:23 +1000127int ssh_remove_all_identities(AuthenticationConnection *auth, int version);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000128
Damien Miller95def091999-11-25 00:26:21 +1100129#endif /* AUTHFD_H */