xref: /openssh-portable/authfd.h (revision 40be78f5)
1 /* $OpenBSD: authfd.h,v 1.48 2019/12/21 02:19:13 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() */
20 struct ssh_identitylist {
21 	size_t nkeys;
22 	struct sshkey **keys;
23 	char **comments;
24 };
25 
26 int	ssh_get_authentication_socket(int *fdp);
27 int	ssh_get_authentication_socket_path(const char *authsocket, int *fdp);
28 void	ssh_close_authentication_socket(int sock);
29 
30 int	ssh_lock_agent(int sock, int lock, const char *password);
31 int	ssh_fetch_identitylist(int sock, struct ssh_identitylist **idlp);
32 void	ssh_free_identitylist(struct ssh_identitylist *idl);
33 int	ssh_add_identity_constrained(int sock, struct sshkey *key,
34 	    const char *comment, u_int life, u_int confirm, u_int maxsign,
35 	    const char *provider);
36 int	ssh_agent_has_key(int sock, struct sshkey *key);
37 int	ssh_remove_identity(int sock, struct sshkey *key);
38 int	ssh_update_card(int sock, int add, const char *reader_id,
39 	    const char *pin, u_int life, u_int confirm);
40 int	ssh_remove_all_identities(int sock, int version);
41 
42 int	ssh_agent_sign(int sock, const struct sshkey *key,
43 	    u_char **sigp, size_t *lenp,
44 	    const u_char *data, size_t datalen, const char *alg, u_int compat);
45 
46 /* Messages for the authentication agent connection. */
47 #define SSH_AGENTC_REQUEST_RSA_IDENTITIES	1
48 #define SSH_AGENT_RSA_IDENTITIES_ANSWER		2
49 #define SSH_AGENTC_RSA_CHALLENGE		3
50 #define SSH_AGENT_RSA_RESPONSE			4
51 #define SSH_AGENT_FAILURE			5
52 #define SSH_AGENT_SUCCESS			6
53 #define SSH_AGENTC_ADD_RSA_IDENTITY		7
54 #define SSH_AGENTC_REMOVE_RSA_IDENTITY		8
55 #define SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES	9
56 
57 /* private OpenSSH extensions for SSH2 */
58 #define SSH2_AGENTC_REQUEST_IDENTITIES		11
59 #define SSH2_AGENT_IDENTITIES_ANSWER		12
60 #define SSH2_AGENTC_SIGN_REQUEST		13
61 #define SSH2_AGENT_SIGN_RESPONSE		14
62 #define SSH2_AGENTC_ADD_IDENTITY		17
63 #define SSH2_AGENTC_REMOVE_IDENTITY		18
64 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES	19
65 
66 /* smartcard */
67 #define SSH_AGENTC_ADD_SMARTCARD_KEY		20
68 #define SSH_AGENTC_REMOVE_SMARTCARD_KEY		21
69 
70 /* lock/unlock the agent */
71 #define SSH_AGENTC_LOCK				22
72 #define SSH_AGENTC_UNLOCK			23
73 
74 /* add key with constraints */
75 #define SSH_AGENTC_ADD_RSA_ID_CONSTRAINED	24
76 #define SSH2_AGENTC_ADD_ID_CONSTRAINED		25
77 #define SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED 26
78 
79 #define	SSH_AGENT_CONSTRAIN_LIFETIME		1
80 #define	SSH_AGENT_CONSTRAIN_CONFIRM		2
81 #define	SSH_AGENT_CONSTRAIN_MAXSIGN		3
82 #define	SSH_AGENT_CONSTRAIN_EXTENSION		255
83 
84 /* extended failure messages */
85 #define SSH2_AGENT_FAILURE			30
86 
87 /* additional error code for ssh.com's ssh-agent2 */
88 #define SSH_COM_AGENT2_FAILURE			102
89 
90 #define	SSH_AGENT_OLD_SIGNATURE			0x01
91 #define	SSH_AGENT_RSA_SHA2_256			0x02
92 #define	SSH_AGENT_RSA_SHA2_512			0x04
93 
94 #endif				/* AUTHFD_H */
95