1/* $OpenBSD: authfd.h,v 1.44 2018/07/12 04:35:25 djm Exp $ */
2
3/*
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 *                    All rights reserved
7 * Functions to interface with the SSH_AUTHENTICATION_FD socket.
8 *
9 * As far as I am concerned, the code I have written for this software
10 * can be used freely for any purpose.  Any derived versions of this
11 * software must be clearly marked as such, and if the derived work is
12 * incompatible with the protocol description in the RFC file, it must be
13 * called by a name other than "ssh" or "Secure Shell".
14 */
15
16#ifndef AUTHFD_H
17#define AUTHFD_H
18
19/* List of identities returned by ssh_fetch_identitylist() */
20struct ssh_identitylist {
21	size_t nkeys;
22	struct sshkey **keys;
23	char **comments;
24};
25
26int	ssh_get_authentication_socket(int *fdp);
27void	ssh_close_authentication_socket(int sock);
28
29int	ssh_lock_agent(int sock, int lock, const char *password);
30int	ssh_fetch_identitylist(int sock, struct ssh_identitylist **idlp);
31void	ssh_free_identitylist(struct ssh_identitylist *idl);
32int	ssh_add_identity_constrained(int sock, const struct sshkey *key,
33	    const char *comment, u_int life, u_int confirm, u_int maxsign);
34int	ssh_remove_identity(int sock, struct sshkey *key);
35int	ssh_update_card(int sock, int add, const char *reader_id,
36	    const char *pin, u_int life, u_int confirm);
37int	ssh_remove_all_identities(int sock, int version);
38
39int	ssh_agent_sign(int sock, const struct sshkey *key,
40	    u_char **sigp, size_t *lenp,
41	    const u_char *data, size_t datalen, const char *alg, u_int compat);
42
43/* Messages for the authentication agent connection. */
44#define SSH_AGENTC_REQUEST_RSA_IDENTITIES	1
45#define SSH_AGENT_RSA_IDENTITIES_ANSWER		2
46#define SSH_AGENTC_RSA_CHALLENGE		3
47#define SSH_AGENT_RSA_RESPONSE			4
48#define SSH_AGENT_FAILURE			5
49#define SSH_AGENT_SUCCESS			6
50#define SSH_AGENTC_ADD_RSA_IDENTITY		7
51#define SSH_AGENTC_REMOVE_RSA_IDENTITY		8
52#define SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES	9
53
54/* private OpenSSH extensions for SSH2 */
55#define SSH2_AGENTC_REQUEST_IDENTITIES		11
56#define SSH2_AGENT_IDENTITIES_ANSWER		12
57#define SSH2_AGENTC_SIGN_REQUEST		13
58#define SSH2_AGENT_SIGN_RESPONSE		14
59#define SSH2_AGENTC_ADD_IDENTITY		17
60#define SSH2_AGENTC_REMOVE_IDENTITY		18
61#define SSH2_AGENTC_REMOVE_ALL_IDENTITIES	19
62
63/* smartcard */
64#define SSH_AGENTC_ADD_SMARTCARD_KEY		20
65#define SSH_AGENTC_REMOVE_SMARTCARD_KEY		21
66
67/* lock/unlock the agent */
68#define SSH_AGENTC_LOCK				22
69#define SSH_AGENTC_UNLOCK			23
70
71/* add key with constraints */
72#define SSH_AGENTC_ADD_RSA_ID_CONSTRAINED	24
73#define SSH2_AGENTC_ADD_ID_CONSTRAINED		25
74#define SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED 26
75
76#define	SSH_AGENT_CONSTRAIN_LIFETIME		1
77#define	SSH_AGENT_CONSTRAIN_CONFIRM		2
78#define	SSH_AGENT_CONSTRAIN_MAXSIGN		3
79
80/* extended failure messages */
81#define SSH2_AGENT_FAILURE			30
82
83/* additional error code for ssh.com's ssh-agent2 */
84#define SSH_COM_AGENT2_FAILURE			102
85
86#define	SSH_AGENT_OLD_SIGNATURE			0x01
87#define	SSH_AGENT_RSA_SHA2_256			0x02
88#define	SSH_AGENT_RSA_SHA2_512			0x04
89
90#endif				/* AUTHFD_H */
91