Annotation of src/usr.bin/ssh/auth.h, Revision 1.103
1.103 ! djm 1: /* $OpenBSD: auth.h,v 1.102 2021/12/19 22:12:07 djm Exp $ */
1.29 stevesk 2:
1.5 deraadt 3: /*
4: * Copyright (c) 2000 Markus Friedl. All rights reserved.
5: *
6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
9: * 1. Redistributions of source code must retain the above copyright
10: * notice, this list of conditions and the following disclaimer.
11: * 2. Redistributions in binary form must reproduce the above copyright
12: * notice, this list of conditions and the following disclaimer in the
13: * documentation and/or other materials provided with the distribution.
14: *
15: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.7 djm 25: *
1.5 deraadt 26: */
1.29 stevesk 27:
1.1 markus 28: #ifndef AUTH_H
29: #define AUTH_H
30:
1.57 deraadt 31: #include <signal.h>
1.10 markus 32:
1.13 markus 33: #include <bsd_auth.h>
1.21 dugsong 34: #ifdef KRB5
35: #include <krb5.h>
36: #endif
1.13 markus 37:
1.95 djm 38: struct passwd;
1.80 markus 39: struct ssh;
1.95 djm 40: struct sshbuf;
1.79 djm 41: struct sshkey;
1.95 djm 42: struct sshauthopt;
1.79 djm 43:
1.6 markus 44: typedef struct Authctxt Authctxt;
1.39 markus 45: typedef struct Authmethod Authmethod;
1.16 markus 46: typedef struct KbdintDevice KbdintDevice;
47:
1.6 markus 48: struct Authctxt {
1.53 djm 49: sig_atomic_t success;
1.58 markus 50: int authenticated; /* authenticated and alarms cancelled */
1.42 markus 51: int postponed; /* authentication needs another step */
52: int valid; /* user exists and is allowed to login */
1.21 dugsong 53: int attempt;
54: int failures;
1.84 djm 55: int server_caused_failure;
1.49 markus 56: int force_pwchange;
1.42 markus 57: char *user; /* username sent by the client */
1.21 dugsong 58: char *service;
1.42 markus 59: struct passwd *pw; /* set if 'valid' */
1.21 dugsong 60: char *style;
1.92 djm 61:
62: /* Method lists for multiple authentication */
63: char **auth_methods; /* modified from server config */
64: u_int num_auth_methods;
65:
66: /* Authentication method-specific data */
67: void *methoddata;
1.21 dugsong 68: void *kbdintctxt;
69: auth_session_t *as;
70: #ifdef KRB5
71: krb5_context krb5_ctx;
72: krb5_ccache krb5_fwd_ccache;
73: krb5_principal krb5_user;
74: char *krb5_ticket_file;
1.13 markus 75: #endif
1.79 djm 76:
1.92 djm 77: /* Authentication keys already used; these will be refused henceforth */
78: struct sshkey **prev_keys;
79: u_int nprev_keys;
80:
1.96 djm 81: /* Last used key and ancillary information from active auth method */
1.92 djm 82: struct sshkey *auth_method_key;
83: char *auth_method_info;
84:
85: /* Information exposed to session */
86: struct sshbuf *session_info; /* Auth info for environment */
1.6 markus 87: };
1.92 djm 88:
1.42 markus 89: /*
90: * Every authentication method has to handle authentication requests for
91: * non-existing users, or for users that are not allowed to login. In this
92: * case 'valid' is set to 0, but 'user' points to the username requested by
93: * the client.
94: */
1.10 markus 95:
1.39 markus 96: struct Authmethod {
97: char *name;
1.102 djm 98: char *synonym;
99: int (*userauth)(struct ssh *, const char *);
1.39 markus 100: int *enabled;
101: };
102:
1.10 markus 103: /*
1.16 markus 104: * Keyboard interactive device:
1.25 deraadt 105: * init_ctx returns: non NULL upon success
106: * query returns: 0 - success, otherwise failure
1.16 markus 107: * respond returns: 0 - success, 1 - need further interaction,
108: * otherwise - failure
109: */
110: struct KbdintDevice
111: {
112: const char *name;
1.27 millert 113: void* (*init_ctx)(Authctxt*);
1.28 millert 114: int (*query)(void *ctx, char **name, char **infotxt,
115: u_int *numprompts, char ***prompts, u_int **echo_on);
1.27 millert 116: int (*respond)(void *ctx, u_int numresp, char **responses);
117: void (*free_ctx)(void *ctx);
1.16 markus 118: };
119:
1.15 markus 120: int
1.20 itojun 121: auth_rhosts2(struct passwd *, const char *, const char *, const char *);
1.10 markus 122:
1.95 djm 123: int auth_password(struct ssh *, const char *);
1.35 markus 124:
1.99 djm 125: int hostbased_key_allowed(struct ssh *, struct passwd *,
126: const char *, char *, struct sshkey *);
1.103 ! djm 127: int user_key_allowed(struct passwd *, struct sshkey *, int,
! 128: const char *, const char *, struct sshauthopt **);
1.92 djm 129: int auth2_key_already_used(Authctxt *, const struct sshkey *);
130:
131: /*
132: * Handling auth method-specific information for logging and prevention
133: * of key reuse during multiple authentication.
134: */
135: void auth2_authctxt_reset_info(Authctxt *);
136: void auth2_record_key(Authctxt *, int, const struct sshkey *);
137: void auth2_record_info(Authctxt *authctxt, const char *, ...)
138: __attribute__((__format__ (printf, 2, 3)))
139: __attribute__((__nonnull__ (2)));
140: void auth2_update_session_info(Authctxt *, const char *, const char *);
1.21 dugsong 141:
142: #ifdef KRB5
1.40 itojun 143: int auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
1.21 dugsong 144: int auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
145: int auth_krb5_password(Authctxt *authctxt, const char *password);
1.47 markus 146: void krb5_cleanup_proc(Authctxt *authctxt);
1.21 dugsong 147: #endif /* KRB5 */
1.6 markus 148:
1.97 djm 149: void do_authentication2(struct ssh *);
1.2 markus 150:
1.98 djm 151: void auth_log(struct ssh *, int, int, const char *, const char *);
152: void auth_maxtries_exceeded(struct ssh *) __attribute__((noreturn));
1.91 markus 153: void userauth_finish(struct ssh *, int, const char *, const char *);
1.95 djm 154: int auth_root_allowed(struct ssh *, const char *);
1.36 djm 155:
156: char *auth2_read_banner(void);
1.71 djm 157: int auth2_methods_valid(const char *, int);
1.73 markus 158: int auth2_update_methods_lists(Authctxt *, const char *, const char *);
1.71 djm 159: int auth2_setup_methods_lists(Authctxt *);
1.73 markus 160: int auth2_method_allowed(Authctxt *, const char *, const char *);
1.6 markus 161:
1.34 provos 162: void privsep_challenge_enable(void);
163:
1.91 markus 164: int auth2_challenge(struct ssh *, char *);
165: void auth2_challenge_stop(struct ssh *);
1.35 markus 166: int bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
167: int bsdauth_respond(void *, u_int, char **);
1.1 markus 168:
1.98 djm 169: int allowed_user(struct ssh *, struct passwd *);
170: struct passwd * getpwnamallow(struct ssh *, const char *user);
1.9 markus 171:
1.69 djm 172: char *expand_authorized_keys(const char *, struct passwd *pw);
1.66 djm 173: char *authorized_principals_file(struct passwd *);
1.17 markus 174:
1.61 dtucker 175: FILE *auth_openkeyfile(const char *, struct passwd *, int);
1.66 djm 176: FILE *auth_openprincipals(const char *, struct passwd *, int);
1.90 markus 177: int auth_key_is_revoked(struct sshkey *);
1.87 djm 178:
179: const char *auth_get_canonical_hostname(struct ssh *, int);
1.18 markus 180:
181: HostStatus
1.90 markus 182: check_key_in_hostfiles(struct passwd *, struct sshkey *, const char *,
1.20 itojun 183: const char *, const char *);
1.35 markus 184:
185: /* hostkey handling */
1.90 markus 186: struct sshkey *get_hostkey_by_index(int);
187: struct sshkey *get_hostkey_public_by_index(int, struct ssh *);
188: struct sshkey *get_hostkey_public_by_type(int, int, struct ssh *);
189: struct sshkey *get_hostkey_private_by_type(int, int, struct ssh *);
190: int get_hostkey_index(struct sshkey *, int, struct ssh *);
1.99 djm 191: int sshd_hostkey_sign(struct ssh *, struct sshkey *, struct sshkey *,
192: u_char **, size_t *, const u_char *, size_t, const char *);
1.37 markus 193:
1.95 djm 194: /* Key / cert options linkage to auth layer */
195: const struct sshauthopt *auth_options(struct ssh *);
196: int auth_activate_options(struct ssh *, struct sshauthopt *);
197: void auth_restrict_session(struct ssh *);
1.103 ! djm 198: int auth_authorise_keyopts(struct passwd *pw, struct sshauthopt *, int,
! 199: const char *, const char *, const char *);
1.95 djm 200: void auth_log_authopts(const char *, const struct sshauthopt *, int);
201:
1.37 markus 202: /* debug messages during authentication */
1.95 djm 203: void auth_debug_add(const char *fmt,...)
204: __attribute__((format(printf, 1, 2)));
1.98 djm 205: void auth_debug_send(struct ssh *);
1.37 markus 206: void auth_debug_reset(void);
1.45 markus 207:
208: struct passwd *fakepw(void);
1.3 markus 209:
1.1 markus 210: #endif