ipsec_util.h revision a74858089ab88f6b5b2788e8ca504c5586da8af5
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _IPSEC_UTIL_H
#define _IPSEC_UTIL_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Headers and definitions for support functions that are shared by
* the ipsec utilities ipseckey and ikeadm.
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <setjmp.h>
#include <stdio.h>
#include <err.h>
#include <net/pfpolicy.h>
#ifndef A_CNT
/* macros for array manipulation */
#endif
/* used for file parsing */
#define NBUF_SIZE 16
#define IBUF_SIZE 512
#define COMMENT_CHAR '#'
#define CONT_CHAR '\\'
#define QUOTE_CHAR '"'
/* used for command-line parsing */
#define START_ARG 8
#define TOO_MANY_TOKENS -3
#define MEMORY_ALLOCATION -2
#define COMMENT_LINE 1
#define SUCCESS 0
/*
* Time printing defines...
*
* TBUF_SIZE is pretty arbitrary. Perhaps it shouldn't be.
*/
#define TBUF_SIZE 50
/* For keyword-lookup tables */
typedef struct keywdtab {
char *kw_str;
} keywdtab_t;
/*
* Function Prototypes
*/
/*
* Print errno and if cmdline or readfile, exit; if interactive reset state
*/
extern void bail(char *);
/*
*/
/*
* Print caller-supplied, variable-arg error message, then exit if cmdline
* or readfile, or reset state if interactive.
*/
extern void bail_msg(char *, ...);
/*
* dump_XXX functions produce ASCII output from the passed in data.
*
* Because certain errors need to do this stderr, dump_XXX functions
* take a FILE pointer.
*/
/* return true if sadb string is printable (based on type), false otherwise */
/*
* do_interactive: Enter a mode where commands are read from a file;
* treat stdin special. infile is the file cmds are read from;
* promptstring is the string printed to stdout (if the cmds are
* being read from stdin) to prompt for a new command; parseit is
* the function to be called to process the command line once it's
*/
/* callback function passed in to do_interactive() */
typedef void (*parse_cmdln_fn)(int, char **);
/* convert a string to an IKE_PRIV_* constant */
extern int privstr2num(char *);
/* convert a string to a D_* debug flag */
extern int dbgstr2num(char *);
/* convert a string of debug strings with +|- delimiters to a debug level */
extern int parsedbgopts(char *);
/*
* functions to manipulate the kmcookie-label mapping file
*/
#define KMCFILE "/var/run/ipsec_kmc_map"
/*
* Insert a mapping into the file (if it's not already there), given the
* new label. Return the assigned cookie, or -1 on error.
*/
extern int kmc_insert_mapping(char *);
/*
* Lookup the given cookie and return its corresponding label. Return
* a pointer to the label on success, NULL on error (or if the label is
* not found).
*/
extern char *kmc_lookup_by_cookie(int);
/*
* These globals are declared for us in ipsec_util.c, since it needs to
* refer to them also...
*/
extern boolean_t interactive;
/* For error recovery in interactive or read-file mode. */
/*
* Back-end stuff for getalgby*().
*/
#define INET_IPSECALGSPATH "/etc/inet/"
typedef struct ipsecalgs_pkg {
int alg_num;
char *pkg_name;
/*
* - A dynamically-grown (optionally sorted) array of IPsec protocols
* - Each protocol has an array (again, dynamically grown and sorted)
* of algorithms, each a full-fledged struct ipsecalgent.
* - The getipsecalg*() routines will search the list, then duplicate the
* struct ipsecalgent and return it.
*/
typedef enum {
typedef struct ipsec_proto {
int proto_num;
char *proto_name;
char *proto_pkg;
int proto_numalgs;
struct ipsecalgent **proto_algs;
int proto_algs_npkgs;
extern void _build_internal_algs(ipsec_proto_t **, int *);
extern int _str_to_ipsec_exec_mode(char *, ipsecalgs_exec_mode_t *);
extern int delipsecalgbyname(const char *, int);
extern int delipsecalgbynum(int, int);
extern int delipsecprotobyname(const char *);
extern int delipsecprotobynum(int);
extern int *getipsecprotos(int *);
extern int *getipsecalgs(int *, int);
extern const char *ipsecalgs_diag(int);
extern int ipsecproto_get_exec_mode(int, ipsecalgs_exec_mode_t *);
extern int ipsecproto_set_exec_mode(int, ipsecalgs_exec_mode_t);
#define LIBIPSEC_ALGS_ADD_FORCE 0x00000001
/*
* Helper definitions for indices into array of key sizes when key sizes
* are defined by range.
*/
#define LIBIPSEC_ALGS_KEY_DEF_IDX 0 /* default key size */
/* Error codes for IPsec algorithms management */
#define LIBIPSEC_ALGS_DIAG_ALG_EXISTS -1
#define LIBIPSEC_ALGS_DIAG_PROTO_EXISTS -2
#define LIBIPSEC_ALGS_DIAG_UNKN_PROTO -3
#define LIBIPSEC_ALGS_DIAG_UNKN_ALG -4
#define LIBIPSEC_ALGS_DIAG_NOMEM -5
#define LIBIPSEC_ALGS_DIAG_ALGSFILEOPEN -6
#define LIBIPSEC_ALGS_DIAG_ALGSFILEFDOPEN -7
#define LIBIPSEC_ALGS_DIAG_ALGSFILELOCK -8
#define LIBIPSEC_ALGS_DIAG_ALGSFILERENAME -9
#define LIBIPSEC_ALGS_DIAG_ALGSFILEWRITE -10
#define LIBIPSEC_ALGS_DIAG_ALGSFILECHMOD -11
#define LIBIPSEC_ALGS_DIAG_ALGSFILECHOWN -12
#define LIBIPSEC_ALGS_DIAG_ALGSFILECLOSE -13
#define LIBIPSEC_ALGS_LINE_PROTO "PROTO|"
#define LIBIPSEC_ALGS_LINE_ALG "ALG|"
#define LIBIPSEC_ALGS_LINE_PKGSTART "# Start "
#define LIBIPSEC_ALGS_LINE_PKGEND "# End "
/* Put these in libnsl for and process caching testing. */
extern int *_real_getipsecprotos(int *);
extern int *_real_getipsecalgs(int *, int);
extern void _clean_trash(ipsec_proto_t *, int);
/* spdsock support functions */
/* Return values for spdsock_get_ext(). */
#define KGE_OK 0
#define KGE_DUP 1
#define KGE_UNK 2
#define KGE_LEN 3
#define KGE_CHK 4
extern const char *spdsock_diag(int);
/* PF_KEY (keysock) support functions */
extern const char *keysock_diag(int);
/* SA support functions */
extern void printsatime(int64_t, const char *, const char *, const char *,
extern void print_address(char *, struct sadb_address *);
extern void print_ident(char *, struct sadb_ident *);
extern void print_sens(char *, struct sadb_sens *);
extern void print_prop(char *, struct sadb_prop *);
extern void print_eprop(char *, struct sadb_prop *);
extern void print_supp(char *, struct sadb_supported *);
extern void print_spirange(char *, struct sadb_spirange *);
extern void print_kmc(char *, struct sadb_x_kmc *);
extern char *rparsesatype(int);
extern char *rparseidtype(uint16_t);
extern FILE *opensavefile(char *);
extern const char *do_inet_ntop(const void *, char *, size_t);
#ifdef __cplusplus
}
#endif
#endif /* _IPSEC_UTIL_H */