xref: /openbsd/usr.bin/ssh/authfd.h (revision eead3eb2)
1 /* $OpenBSD: authfd.h,v 1.52 2023/12/18 14:46:56 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 struct sshbuf;
20 struct sshkey;
21 
22 /* List of identities returned by ssh_fetch_identitylist() */
23 struct ssh_identitylist {
24 	size_t nkeys;
25 	struct sshkey **keys;
26 	char **comments;
27 };
28 
29 /* Key destination restrictions */
30 struct dest_constraint_hop {
31 	char *user;	/* wildcards allowed */
32 	char *hostname; /* used to matching cert principals and for display */
33 	int is_ca;
34 	u_int nkeys;	/* number of entries in *both* 'keys' and 'key_is_ca' */
35 	struct sshkey **keys;
36 	int *key_is_ca;
37 };
38 struct dest_constraint {
39 	struct dest_constraint_hop from;
40 	struct dest_constraint_hop to;
41 };
42 
43 int	ssh_get_authentication_socket(int *fdp);
44 int	ssh_get_authentication_socket_path(const char *authsocket, int *fdp);
45 void	ssh_close_authentication_socket(int sock);
46 
47 int	ssh_lock_agent(int sock, int lock, const char *password);
48 int	ssh_fetch_identitylist(int sock, struct ssh_identitylist **idlp);
49 void	ssh_free_identitylist(struct ssh_identitylist *idl);
50 int	ssh_add_identity_constrained(int sock, struct sshkey *key,
51     const char *comment, u_int life, u_int confirm, u_int maxsign,
52     const char *provider, struct dest_constraint **dest_constraints,
53     size_t ndest_constraints);
54 int	ssh_agent_has_key(int sock, const struct sshkey *key);
55 int	ssh_remove_identity(int sock, const struct sshkey *key);
56 int	ssh_update_card(int sock, int add, const char *reader_id,
57 	    const char *pin, u_int life, u_int confirm,
58 	    struct dest_constraint **dest_constraints,
59 	    size_t ndest_constraints,
60 	    int cert_only, struct sshkey **certs, size_t ncerts);
61 int	ssh_remove_all_identities(int sock, int version);
62 
63 int	ssh_agent_sign(int sock, const struct sshkey *key,
64 	    u_char **sigp, size_t *lenp,
65 	    const u_char *data, size_t datalen, const char *alg, u_int compat);
66 
67 int	ssh_agent_bind_hostkey(int sock, const struct sshkey *key,
68     const struct sshbuf *session_id, const struct sshbuf *signature,
69     int forwarding);
70 
71 /* Messages for the authentication agent connection. */
72 #define SSH_AGENTC_REQUEST_RSA_IDENTITIES	1
73 #define SSH_AGENT_RSA_IDENTITIES_ANSWER		2
74 #define SSH_AGENTC_RSA_CHALLENGE		3
75 #define SSH_AGENT_RSA_RESPONSE			4
76 #define SSH_AGENT_FAILURE			5
77 #define SSH_AGENT_SUCCESS			6
78 #define SSH_AGENTC_ADD_RSA_IDENTITY		7
79 #define SSH_AGENTC_REMOVE_RSA_IDENTITY		8
80 #define SSH_AGENTC_REMOVE_ALL_RSA_IDENTITIES	9
81 
82 /* private OpenSSH extensions for SSH2 */
83 #define SSH2_AGENTC_REQUEST_IDENTITIES		11
84 #define SSH2_AGENT_IDENTITIES_ANSWER		12
85 #define SSH2_AGENTC_SIGN_REQUEST		13
86 #define SSH2_AGENT_SIGN_RESPONSE		14
87 #define SSH2_AGENTC_ADD_IDENTITY		17
88 #define SSH2_AGENTC_REMOVE_IDENTITY		18
89 #define SSH2_AGENTC_REMOVE_ALL_IDENTITIES	19
90 
91 /* smartcard */
92 #define SSH_AGENTC_ADD_SMARTCARD_KEY		20
93 #define SSH_AGENTC_REMOVE_SMARTCARD_KEY		21
94 
95 /* lock/unlock the agent */
96 #define SSH_AGENTC_LOCK				22
97 #define SSH_AGENTC_UNLOCK			23
98 
99 /* add key with constraints */
100 #define SSH_AGENTC_ADD_RSA_ID_CONSTRAINED	24
101 #define SSH2_AGENTC_ADD_ID_CONSTRAINED		25
102 #define SSH_AGENTC_ADD_SMARTCARD_KEY_CONSTRAINED 26
103 
104 /* generic extension mechanism */
105 #define SSH_AGENTC_EXTENSION			27
106 
107 #define	SSH_AGENT_CONSTRAIN_LIFETIME		1
108 #define	SSH_AGENT_CONSTRAIN_CONFIRM		2
109 #define	SSH_AGENT_CONSTRAIN_MAXSIGN		3
110 #define	SSH_AGENT_CONSTRAIN_EXTENSION		255
111 
112 /* extended failure messages */
113 #define SSH2_AGENT_FAILURE			30
114 
115 /* additional error code for ssh.com's ssh-agent2 */
116 #define SSH_COM_AGENT2_FAILURE			102
117 
118 #define	SSH_AGENT_OLD_SIGNATURE			0x01
119 #define	SSH_AGENT_RSA_SHA2_256			0x02
120 #define	SSH_AGENT_RSA_SHA2_512			0x04
121 
122 #endif				/* AUTHFD_H */
123