Home | History | Annotate | Line # | Download | only in dist
auth-options.h revision 1.10.2.1 
      1 /*	$NetBSD: auth-options.h,v 1.10.2.1 2019/06/10 21:41:11 christos Exp $	*/
      2 /* $OpenBSD: auth-options.h,v 1.27 2018/06/06 18:23:32 djm Exp $ */
      3 
      4 /*
      5  * Copyright (c) 2018 Damien Miller <djm (at) mindrot.org>
      6  *
      7  * Permission to use, copy, modify, and distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 #ifndef AUTH_OPTIONS_H
     21 #define AUTH_OPTIONS_H
     22 
     23 struct passwd;
     24 struct sshkey;
     25 
     26 /*
     27  * sshauthopt represents key options parsed from authorized_keys or
     28  * from certificate extensions/options.
     29  */
     30 struct sshauthopt {
     31 	/* Feature flags */
     32 	int permit_port_forwarding_flag;
     33 	int permit_agent_forwarding_flag;
     34 	int permit_x11_forwarding_flag;
     35 	int permit_pty_flag;
     36 	int permit_user_rc;
     37 
     38 	/* "restrict" keyword was invoked */
     39 	int restricted;
     40 
     41 	/* key/principal expiry date */
     42 	uint64_t valid_before;
     43 
     44 	/* Certificate-related options */
     45 	int cert_authority;
     46 	char *cert_principals;
     47 
     48 	int force_tun_device;
     49 	char *force_command;
     50 
     51 	/* Custom environment */
     52 	size_t nenv;
     53 	char **env;
     54 
     55 	/* Permitted port forwardings */
     56 	size_t npermitopen;
     57 	char **permitopen;
     58 
     59 	/* Permitted listens (remote forwarding) */
     60 	size_t npermitlisten;
     61 	char **permitlisten;
     62 
     63 	/*
     64 	 * Permitted host/addresses (comma-separated)
     65 	 * Caller must check source address matches both lists (if present).
     66 	 */
     67 	char *required_from_host_cert;
     68 	char *required_from_host_keys;
     69 };
     70 
     71 struct sshauthopt *sshauthopt_new(void);
     72 struct sshauthopt *sshauthopt_new_with_keys_defaults(void);
     73 void sshauthopt_free(struct sshauthopt *opts);
     74 struct sshauthopt *sshauthopt_copy(const struct sshauthopt *orig);
     75 int sshauthopt_serialise(const struct sshauthopt *opts, struct sshbuf *m, int);
     76 int sshauthopt_deserialise(struct sshbuf *m, struct sshauthopt **opts);
     77 
     78 /*
     79  * Parse authorized_keys options. Returns an options structure on success
     80  * or NULL on failure. Will set errstr on failure.
     81  */
     82 struct sshauthopt *sshauthopt_parse(const char *s, const char **errstr);
     83 
     84 /*
     85  * Parse certification options to a struct sshauthopt.
     86  * Returns options on success or NULL on failure.
     87  */
     88 struct sshauthopt *sshauthopt_from_cert(struct sshkey *k);
     89 
     90 /*
     91  * Merge key options.
     92  */
     93 struct sshauthopt *sshauthopt_merge(const struct sshauthopt *primary,
     94     const struct sshauthopt *additional, const char **errstrp);
     95 
     96 #endif
     97