1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _IPSEC_UTIL_H 27 #define _IPSEC_UTIL_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 /* 32 * Headers and definitions for support functions that are shared by 33 * the ipsec utilities ipseckey and ikeadm. 34 */ 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 #include <sys/types.h> 41 #include <sys/socket.h> 42 #include <net/pfkeyv2.h> 43 #include <netinet/in.h> 44 #include <inet/ip.h> 45 #include <setjmp.h> 46 #include <stdio.h> 47 #include <err.h> 48 #include <net/pfpolicy.h> 49 50 #ifndef A_CNT 51 /* macros for array manipulation */ 52 #define A_CNT(arr) (sizeof (arr)/sizeof (arr[0])) 53 #define A_END(arr) (&arr[A_CNT(arr)]) 54 #endif 55 56 /* used for file parsing */ 57 #define NBUF_SIZE 16 58 #define IBUF_SIZE 512 59 #define COMMENT_CHAR '#' 60 #define CONT_CHAR '\\' 61 #define QUOTE_CHAR '"' 62 63 /* used for command-line parsing */ 64 #define START_ARG 8 65 #define TOO_MANY_ARGS (START_ARG << 9) 66 67 /* Return codes for argv/argc vector creation */ 68 #define TOO_MANY_TOKENS -3 69 #define MEMORY_ALLOCATION -2 70 #define COMMENT_LINE 1 71 #define SUCCESS 0 72 73 /* 74 * Time printing defines... 75 * 76 * TBUF_SIZE is pretty arbitrary. Perhaps it shouldn't be. 77 */ 78 #define TBUF_SIZE 50 79 #define TIME_MAX LONG_MAX 80 81 /* For keyword-lookup tables */ 82 typedef struct keywdtab { 83 uint_t kw_tag; 84 char *kw_str; 85 } keywdtab_t; 86 87 /* Exit the programe and enter new state */ 88 typedef enum exit_type { 89 SERVICE_EXIT_OK, 90 SERVICE_DEGRADE, 91 SERVICE_BADPERM, 92 SERVICE_BADCONF, 93 SERVICE_MAINTAIN, 94 SERVICE_DISABLE, 95 SERVICE_FATAL, 96 SERVICE_RESTART 97 } exit_type_t; 98 99 /* 100 * Function Prototypes 101 */ 102 103 /* 104 * Print errno and if cmdline or readfile, exit; if interactive reset state 105 */ 106 extern void ipsecutil_exit(exit_type_t, char *, FILE *, const char *fmt, ...); 107 extern void bail(char *); 108 109 /* 110 * Localization macro - Only to be used from usr/src/cmd because Macros 111 * are not expanded in usr/src/lib when message catalogs are built. 112 */ 113 #define Bail(s) bail(dgettext(TEXT_DOMAIN, s)) 114 115 /* 116 * Print caller-supplied, variable-arg error message, then exit if cmdline 117 * or readfile, or reset state if interactive. 118 */ 119 extern void bail_msg(char *, ...); 120 121 /* 122 * dump_XXX functions produce ASCII output from the passed in data. 123 * 124 * Because certain errors need to do this stderr, dump_XXX functions 125 * take a FILE pointer. 126 */ 127 128 extern int dump_sockaddr(struct sockaddr *, uint8_t, boolean_t, FILE *); 129 130 extern int dump_key(uint8_t *, uint_t, FILE *); 131 132 extern int dump_aalg(uint8_t, FILE *); 133 134 extern int dump_ealg(uint8_t, FILE *); 135 136 /* return true if sadb string is printable (based on type), false otherwise */ 137 extern boolean_t dump_sadb_idtype(uint8_t, FILE *, int *); 138 139 /* 140 * do_interactive: Enter a mode where commands are read from a file; 141 * treat stdin special. infile is the file cmds are read from; 142 * promptstring is the string printed to stdout (if the cmds are 143 * being read from stdin) to prompt for a new command; parseit is 144 * the function to be called to process the command line once it's 145 * been read in and broken up into an argv/argc vector. 146 */ 147 148 /* callback function passed in to do_interactive() */ 149 typedef void (*parse_cmdln_fn)(int, char **, char *); 150 151 extern void do_interactive(FILE *, char *, char *, char *, parse_cmdln_fn); 152 153 extern uint_t lines_parsed; 154 extern uint_t lines_added; 155 156 /* convert a string to an IKE_PRIV_* constant */ 157 extern int privstr2num(char *); 158 159 /* convert a string to a D_* debug flag */ 160 extern int dbgstr2num(char *); 161 162 /* convert a string of debug strings with +|- delimiters to a debug level */ 163 extern int parsedbgopts(char *); 164 165 166 /* 167 * functions to manipulate the kmcookie-label mapping file 168 */ 169 170 #define KMCFILE "/var/run/ipsec_kmc_map" 171 172 /* 173 * Insert a mapping into the file (if it's not already there), given the 174 * new label. Return the assigned cookie, or -1 on error. 175 */ 176 extern int kmc_insert_mapping(char *); 177 178 /* 179 * Lookup the given cookie and return its corresponding label. Return 180 * a pointer to the label on success, NULL on error (or if the label is 181 * not found). 182 */ 183 extern char *kmc_lookup_by_cookie(int); 184 185 /* 186 * These globals are declared for us in ipsec_util.c, since it needs to 187 * refer to them also... 188 */ 189 extern boolean_t nflag; /* Avoid nameservice? */ 190 extern boolean_t pflag; /* Paranoid w.r.t. printing keying material? */ 191 extern boolean_t interactive; 192 extern boolean_t readfile; 193 extern uint_t lineno; 194 extern char numprint[NBUF_SIZE]; 195 196 /* For error recovery in interactive or read-file mode. */ 197 extern jmp_buf env; 198 199 /* 200 * Back-end stuff for getalgby*(). 201 */ 202 203 #define INET_IPSECALGSPATH "/etc/inet/" 204 #define INET_IPSECALGSFILE (INET_IPSECALGSPATH "ipsecalgs") 205 206 /* To preserve packages delimiters in /etc/inet/ipsecalgs */ 207 typedef struct ipsecalgs_pkg { 208 int alg_num; 209 char *pkg_name; 210 } ipsecalgs_pkg_t; 211 212 /* 213 * The cached representation of /etc/inet/ipsecalgs is represented by: 214 * - A dynamically-grown (optionally sorted) array of IPsec protocols 215 * - Each protocol has an array (again, dynamically grown and sorted) 216 * of algorithms, each a full-fledged struct ipsecalgent. 217 * - The getipsecalg*() routines will search the list, then duplicate the 218 * struct ipsecalgent and return it. 219 */ 220 221 typedef enum { 222 LIBIPSEC_ALGS_EXEC_SYNC, 223 LIBIPSEC_ALGS_EXEC_ASYNC 224 } ipsecalgs_exec_mode_t; 225 226 typedef struct ipsec_proto { 227 int proto_num; 228 char *proto_name; 229 char *proto_pkg; 230 int proto_numalgs; 231 struct ipsecalgent **proto_algs; 232 ipsecalgs_pkg_t *proto_algs_pkgs; 233 int proto_algs_npkgs; 234 ipsecalgs_exec_mode_t proto_exec_mode; 235 } ipsec_proto_t; 236 237 extern void _build_internal_algs(ipsec_proto_t **, int *); 238 extern int _str_to_ipsec_exec_mode(char *, ipsecalgs_exec_mode_t *); 239 240 extern int addipsecalg(struct ipsecalgent *, uint_t); 241 extern int delipsecalgbyname(const char *, int); 242 extern int delipsecalgbynum(int, int); 243 extern int addipsecproto(const char *, int, ipsecalgs_exec_mode_t, uint_t); 244 extern int delipsecprotobyname(const char *); 245 extern int delipsecprotobynum(int); 246 extern int *getipsecprotos(int *); 247 extern int *getipsecalgs(int *, int); 248 extern int list_ints(FILE *, int *); 249 extern const char *ipsecalgs_diag(int); 250 extern int ipsecproto_get_exec_mode(int, ipsecalgs_exec_mode_t *); 251 extern int ipsecproto_set_exec_mode(int, ipsecalgs_exec_mode_t); 252 253 /* Flags for add/delete routines. */ 254 #define LIBIPSEC_ALGS_ADD_FORCE 0x00000001 255 256 /* 257 * Helper definitions for indices into array of key sizes when key sizes 258 * are defined by range. 259 */ 260 #define LIBIPSEC_ALGS_KEY_DEF_IDX 0 /* default key size */ 261 #define LIBIPSEC_ALGS_KEY_MIN_IDX 1 /* min key size */ 262 #define LIBIPSEC_ALGS_KEY_MAX_IDX 2 /* max key size */ 263 #define LIBIPSEC_ALGS_KEY_NUM_VAL 4 /* def, min, max, 0 */ 264 265 /* Error codes for IPsec algorithms management */ 266 #define LIBIPSEC_ALGS_DIAG_ALG_EXISTS -1 267 #define LIBIPSEC_ALGS_DIAG_PROTO_EXISTS -2 268 #define LIBIPSEC_ALGS_DIAG_UNKN_PROTO -3 269 #define LIBIPSEC_ALGS_DIAG_UNKN_ALG -4 270 #define LIBIPSEC_ALGS_DIAG_NOMEM -5 271 #define LIBIPSEC_ALGS_DIAG_ALGSFILEOPEN -6 272 #define LIBIPSEC_ALGS_DIAG_ALGSFILEFDOPEN -7 273 #define LIBIPSEC_ALGS_DIAG_ALGSFILELOCK -8 274 #define LIBIPSEC_ALGS_DIAG_ALGSFILERENAME -9 275 #define LIBIPSEC_ALGS_DIAG_ALGSFILEWRITE -10 276 #define LIBIPSEC_ALGS_DIAG_ALGSFILECHMOD -11 277 #define LIBIPSEC_ALGS_DIAG_ALGSFILECHOWN -12 278 #define LIBIPSEC_ALGS_DIAG_ALGSFILECLOSE -13 279 280 /* /etc/inet/ipsecalgs keywords and package sections delimiters */ 281 #define LIBIPSEC_ALGS_LINE_PROTO "PROTO|" 282 #define LIBIPSEC_ALGS_LINE_ALG "ALG|" 283 #define LIBIPSEC_ALGS_LINE_PKGSTART "# Start " 284 #define LIBIPSEC_ALGS_LINE_PKGEND "# End " 285 286 /* Put these in libnsl for and process caching testing. */ 287 extern int *_real_getipsecprotos(int *); 288 extern int *_real_getipsecalgs(int *, int); 289 extern struct ipsecalgent *_duplicate_alg(struct ipsecalgent *); 290 extern void _clean_trash(ipsec_proto_t *, int); 291 292 /* spdsock support functions */ 293 294 /* Return values for spdsock_get_ext(). */ 295 #define KGE_OK 0 296 #define KGE_DUP 1 297 #define KGE_UNK 2 298 #define KGE_LEN 3 299 #define KGE_CHK 4 300 301 extern int spdsock_get_ext(spd_ext_t *[], spd_msg_t *, uint_t, char *, uint_t); 302 extern const char *spdsock_diag(int); 303 304 /* PF_KEY (keysock) support functions */ 305 extern const char *keysock_diag(int); 306 extern int in_masktoprefix(uint8_t *, boolean_t); 307 308 /* SA support functions */ 309 310 extern void print_diagnostic(FILE *, uint16_t); 311 extern void print_sadb_msg(struct sadb_msg *, time_t, boolean_t); 312 extern void print_sa(char *, struct sadb_sa *); 313 extern void printsatime(int64_t, const char *, const char *, const char *, 314 boolean_t); 315 extern void print_lifetimes(time_t, struct sadb_lifetime *, 316 struct sadb_lifetime *, struct sadb_lifetime *, boolean_t vflag); 317 extern void print_address(char *, struct sadb_address *); 318 extern void print_key(char *, struct sadb_key *); 319 extern void print_ident(char *, struct sadb_ident *); 320 extern void print_sens(char *, struct sadb_sens *); 321 extern void print_prop(char *, struct sadb_prop *); 322 extern void print_eprop(char *, struct sadb_prop *); 323 extern void print_supp(char *, struct sadb_supported *); 324 extern void print_spirange(char *, struct sadb_spirange *); 325 extern void print_kmc(char *, struct sadb_x_kmc *); 326 extern void print_samsg(uint64_t *, boolean_t, boolean_t); 327 extern char *rparsesatype(int); 328 extern char *rparsealg(uint8_t, int); 329 extern char *rparseidtype(uint16_t); 330 extern boolean_t save_lifetime(struct sadb_lifetime *, FILE *); 331 extern boolean_t save_address(struct sadb_address *, FILE *); 332 extern boolean_t save_key(struct sadb_key *, FILE *); 333 extern boolean_t save_ident(struct sadb_ident *, FILE *); 334 extern void save_assoc(uint64_t *, FILE *); 335 extern FILE *opensavefile(char *); 336 extern const char *do_inet_ntop(const void *, char *, size_t); 337 338 /* 339 * These exit macros give a consistent exit behaviour for all 340 * programs that use libipsecutil. These wll work in usr/src/cmd 341 * and usr/src/lib, but because macros in usr/src/lib don't get 342 * expanded when I18N message catalogs are built, avoid using 343 * these with text inside libipsecutil. 344 */ 345 #define EXIT_OK(x) \ 346 ipsecutil_exit(SERVICE_EXIT_OK, my_fmri, debugfile, \ 347 dgettext(TEXT_DOMAIN, x)) 348 #define EXIT_OK2(x, y) \ 349 ipsecutil_exit(SERVICE_EXIT_OK, my_fmri, debugfile, \ 350 dgettext(TEXT_DOMAIN, x), y) 351 #define EXIT_OK3(x, y, z) \ 352 ipsecutil_exit(SERVICE_EXIT_OK, my_fmri, debugfile, \ 353 dgettext(TEXT_DOMAIN, x), y, z) 354 #define EXIT_BADCONFIG(x) \ 355 ipsecutil_exit(SERVICE_BADCONF, my_fmri, debugfile, \ 356 dgettext(TEXT_DOMAIN, x)) 357 #define EXIT_BADCONFIG2(x, y) \ 358 ipsecutil_exit(SERVICE_BADCONF, my_fmri, debugfile, \ 359 dgettext(TEXT_DOMAIN, x), y) 360 #define EXIT_BADCONFIG3(x, y, z) \ 361 ipsecutil_exit(SERVICE_BADCONF, my_fmri, debugfile, \ 362 dgettext(TEXT_DOMAIN, x), y, z) 363 #define EXIT_MAINTAIN(x) \ 364 ipsecutil_exit(SERVICE_MAINTAIN, my_fmri, debugfile, \ 365 dgettext(TEXT_DOMAIN, x)) 366 #define EXIT_MAINTAIN2(x, y) \ 367 ipsecutil_exit(SERVICE_MAINTAIN, my_fmri, debugfile, \ 368 dgettext(TEXT_DOMAIN, x), y) 369 #define EXIT_DEGRADE(x) \ 370 ipsecutil_exit(SERVICE_DEGRADE, my_fmri, debugfile, \ 371 dgettext(TEXT_DOMAIN, x)) 372 #define EXIT_BADPERM(x) \ 373 ipsecutil_exit(SERVICE_BADPERM, my_fmri, debugfile, \ 374 dgettext(TEXT_DOMAIN, x)) 375 #define EXIT_BADPERM2(x, y) \ 376 ipsecutil_exit(SERVICE_BADPERM, my_fmri, debugfile, \ 377 dgettext(TEXT_DOMAIN, x), y) 378 #define EXIT_FATAL(x) \ 379 ipsecutil_exit(SERVICE_FATAL, my_fmri, debugfile, \ 380 dgettext(TEXT_DOMAIN, x)) 381 #define EXIT_FATAL2(x, y) \ 382 ipsecutil_exit(SERVICE_FATAL, my_fmri, debugfile, \ 383 dgettext(TEXT_DOMAIN, x), y) 384 #define EXIT_FATAL3(x, y, z) \ 385 ipsecutil_exit(SERVICE_FATAL, my_fmri, debugfile, \ 386 dgettext(TEXT_DOMAIN, x), y, z) 387 #define EXIT_RESTART(x) \ 388 ipsecutil_exit(SERVICE_RESTART, my_fmri, debugfile, \ 389 dgettext(TEXT_DOMAIN, x)) 390 391 #ifdef __cplusplus 392 } 393 #endif 394 395 #endif /* _IPSEC_UTIL_H */ 396