include/net/pfkeyv2.h

   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 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /*
  26  * Copyright (c) 2018, Joyent, Inc.
  27  */
  28
  29 #ifndef _NET_PFKEYV2_H
  30 #define _NET_PFKEYV2_H
  31
  32 /*
  33  * Definitions and structures for PF_KEY version 2.  See RFC 2367 for
  34  * more details.  SA == Security Association, which is what PF_KEY provides
  35  * an API for managing.
  36  */
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 #define PF_KEY_V2               2
  43 #define PFKEYV2_REVISION        200109L
  44
  45 /*
  46  * Base PF_KEY message.
  47  */
  48
  49 typedef struct sadb_msg {
  50         uint8_t sadb_msg_version;       /* Version, currently PF_KEY_V2 */
  51         uint8_t sadb_msg_type;          /* ADD, UPDATE, etc. */
  52         uint8_t sadb_msg_errno;         /* Error number from UNIX errno space */
  53         uint8_t sadb_msg_satype;        /* ESP, AH, etc. */
  54         uint16_t sadb_msg_len;          /* Length in 64-bit words. */
  55         uint16_t sadb_msg_reserved;     /* must be zero */
  56 /*
  57  * Use the reserved field for extended diagnostic information on errno
  58  * responses.
  59  */
  60 #define sadb_x_msg_diagnostic sadb_msg_reserved
  61         /* Union is for guaranteeing 64-bit alignment. */
  62         union {
  63                 struct {
  64                         uint32_t sadb_x_msg_useq;       /* Set by originator */
  65                         uint32_t sadb_x_msg_upid;       /* Set by originator */
  66                 } sadb_x_msg_actual;
  67                 uint64_t sadb_x_msg_alignment;
  68         } sadb_x_msg_u;
  69 #define sadb_msg_seq sadb_x_msg_u.sadb_x_msg_actual.sadb_x_msg_useq
  70 #define sadb_msg_pid sadb_x_msg_u.sadb_x_msg_actual.sadb_x_msg_upid
  71 } sadb_msg_t;
  72
  73 /*
  74  * Generic extension header.
  75  */
  76
  77 typedef struct sadb_ext {
  78         union {
  79                 /* Union is for guaranteeing 64-bit alignment. */
  80                 struct {
  81                         uint16_t sadb_x_ext_ulen;       /* In 64s, inclusive */
  82                         uint16_t sadb_x_ext_utype;      /* 0 is reserved */
  83                 } sadb_x_ext_actual;
  84                 uint64_t sadb_x_ext_alignment;
  85         } sadb_x_ext_u;
  86 #define sadb_ext_len sadb_x_ext_u.sadb_x_ext_actual.sadb_x_ext_ulen
  87 #define sadb_ext_type sadb_x_ext_u.sadb_x_ext_actual.sadb_x_ext_utype
  88 } sadb_ext_t;
  89
  90 /*
  91  * Security Association information extension.
  92  */
  93
  94 typedef struct sadb_sa {
  95         /* Union is for guaranteeing 64-bit alignment. */
  96         union {
  97                 struct {
  98                         uint16_t sadb_x_sa_ulen;
  99                         uint16_t sadb_x_sa_uexttype;    /* ASSOCIATION */
 100                         uint32_t sadb_x_sa_uspi;        /* Sec. Param. Index */
 101                 } sadb_x_sa_uactual;
 102                 uint64_t sadb_x_sa_alignment;
 103         } sadb_x_sa_u;
 104 #define sadb_sa_len sadb_x_sa_u.sadb_x_sa_uactual.sadb_x_sa_ulen
 105 #define sadb_sa_exttype sadb_x_sa_u.sadb_x_sa_uactual.sadb_x_sa_uexttype
 106 #define sadb_sa_spi sadb_x_sa_u.sadb_x_sa_uactual.sadb_x_sa_uspi
 107         uint8_t sadb_sa_replay;         /* Replay counter */
 108         uint8_t sadb_sa_state;          /* MATURE, DEAD, DYING, LARVAL */
 109         uint8_t sadb_sa_auth;           /* Authentication algorithm */
 110         uint8_t sadb_sa_encrypt;        /* Encryption algorithm */
 111         uint32_t sadb_sa_flags;         /* SA flags. */
 112 } sadb_sa_t;
 113
 114 /*
 115  * SA Lifetime extension.  Already 64-bit aligned thanks to uint64_t fields.
 116  */
 117
 118 typedef struct sadb_lifetime {
 119         uint16_t sadb_lifetime_len;
 120         uint16_t sadb_lifetime_exttype;         /* SOFT, HARD, CURRENT */
 121         uint32_t sadb_lifetime_allocations;
 122         uint64_t sadb_lifetime_bytes;
 123         uint64_t sadb_lifetime_addtime; /* These fields are assumed to hold */
 124         uint64_t sadb_lifetime_usetime; /* >= sizeof (time_t). */
 125 } sadb_lifetime_t;
 126
 127 /*
 128  * SA address information.
 129  */
 130
 131 typedef struct sadb_address {
 132         /* Union is for guaranteeing 64-bit alignment. */
 133         union {
 134                 struct {
 135                         uint16_t sadb_x_address_ulen;
 136                         uint16_t sadb_x_address_uexttype; /* SRC, DST, PROXY */
 137                         uint8_t sadb_x_address_uproto; /* Proto for ports... */
 138                         uint8_t sadb_x_address_uprefixlen; /* Prefix length. */
 139                         uint16_t sadb_x_address_ureserved; /* Padding */
 140                 } sadb_x_address_actual;
 141                 uint64_t sadb_x_address_alignment;
 142         } sadb_x_address_u;
 143 #define sadb_address_len \
 144         sadb_x_address_u.sadb_x_address_actual.sadb_x_address_ulen
 145 #define sadb_address_exttype \
 146         sadb_x_address_u.sadb_x_address_actual.sadb_x_address_uexttype
 147 #define sadb_address_proto \
 148         sadb_x_address_u.sadb_x_address_actual.sadb_x_address_uproto
 149 #define sadb_address_prefixlen \
 150         sadb_x_address_u.sadb_x_address_actual.sadb_x_address_uprefixlen
 151 #define sadb_address_reserved \
 152         sadb_x_address_u.sadb_x_address_actual.sadb_x_address_ureserved
 153         /* Followed by a sockaddr structure which may contain ports. */
 154 } sadb_address_t;
 155
 156 /*
 157  * SA key information.
 158  */
 159
 160 typedef struct sadb_key {
 161         /* Union is for guaranteeing 64-bit alignment. */
 162         union {
 163                 struct {
 164                         uint16_t sadb_x_key_ulen;
 165                         uint16_t sadb_x_key_uexttype;   /* AUTH, ENCRYPT */
 166                         uint16_t sadb_x_key_ubits;      /* Actual len (bits) */
 167                         uint16_t sadb_x_key_ureserved;
 168                 } sadb_x_key_actual;
 169                 uint64_t sadb_x_key_alignment;
 170         } sadb_x_key_u;
 171 #define sadb_key_len sadb_x_key_u.sadb_x_key_actual.sadb_x_key_ulen
 172 #define sadb_key_exttype sadb_x_key_u.sadb_x_key_actual.sadb_x_key_uexttype
 173 #define sadb_key_bits sadb_x_key_u.sadb_x_key_actual.sadb_x_key_ubits
 174 #define sadb_key_reserved sadb_x_key_u.sadb_x_key_actual.sadb_x_key_ureserved
 175         /* Followed by actual key(s) in canonical (outbound proc.) order. */
 176 } sadb_key_t;
 177
 178 /*
 179  * SA Identity information.  Already 64-bit aligned thanks to uint64_t fields.
 180  */
 181
 182 typedef struct sadb_ident {
 183         uint16_t sadb_ident_len;
 184         uint16_t sadb_ident_exttype;    /* SRC, DST, PROXY */
 185         uint16_t sadb_ident_type;       /* FQDN, USER_FQDN, etc. */
 186         uint16_t sadb_ident_reserved;   /* Padding */
 187         uint64_t sadb_ident_id;         /* For userid, etc. */
 188         /* Followed by an identity null-terminate C string if present. */
 189 } sadb_ident_t;
 190
 191 /*
 192  * a proposal extension.  This is found in an ACQUIRE message, and it
 193  * proposes what sort of SA the kernel would like to ACQUIRE.
 194  */
 195
 196 /* First, a base structure... */
 197
 198 typedef struct sadb_x_propbase {
 199         uint16_t sadb_x_propb_len;
 200         uint16_t sadb_x_propb_exttype;  /* PROPOSAL, X_EPROP */
 201         union {
 202                 struct {
 203                         uint8_t sadb_x_propb_lenres_replay;
 204                         uint8_t sadb_x_propb_lenres_eres;
 205                         uint16_t sadb_x_propb_lenres_numecombs;
 206                 } sadb_x_propb_lenres;
 207                 struct {
 208                         uint8_t sadb_x_propb_oldres_replay;
 209                         uint8_t sadb_x_propb_oldres_reserved[3];
 210                 } sadb_x_propb_oldres;
 211         } sadb_x_propb_u;
 212 #define sadb_x_propb_replay \
 213         sadb_x_propb_u.sadb_x_propb_lenres.sadb_x_propb_lenres_replay
 214 #define sadb_x_propb_reserved \
 215         sadb_x_propb_u.sadb_x_propb_oldres.sadb_x_propb_oldres_reserved
 216 #define sadb_x_propb_ereserved \
 217         sadb_x_propb_u.sadb_x_propb_lenres.sadb_x_propb_lenres_eres
 218 #define sadb_x_propb_numecombs \
 219         sadb_x_propb_u.sadb_x_propb_lenres.sadb_x_propb_lenres_numecombs
 220         /* Followed by sadb_comb[] array or sadb_ecomb[] array. */
 221 } sadb_x_propbase_t;
 222
 223 /* Now, the actual sadb_prop structure, which will have alignment in it! */
 224
 225 typedef struct sadb_prop {
 226         /* Union is for guaranteeing 64-bit alignment. */
 227         union {
 228                 sadb_x_propbase_t sadb_x_prop_actual;
 229                 uint64_t sadb_x_prop_alignment;
 230         } sadb_x_prop_u;
 231 #define sadb_prop_len sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_len
 232 #define sadb_prop_exttype sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_exttype
 233 #define sadb_prop_replay sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_replay
 234 #define sadb_prop_reserved \
 235         sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_reserved
 236 #define sadb_x_prop_ereserved \
 237         sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_ereserved
 238 #define sadb_x_prop_numecombs \
 239         sadb_x_prop_u.sadb_x_prop_actual.sadb_x_propb_numecombs
 240 } sadb_prop_t;
 241
 242 /*
 243  * This is a proposed combination.  Many of these can follow a proposal
 244  * extension.  Already 64-bit aligned thanks to uint64_t fields.
 245  */
 246
 247 typedef struct sadb_comb {
 248         uint8_t sadb_comb_auth;                 /* Authentication algorithm */
 249         uint8_t sadb_comb_encrypt;              /* Encryption algorithm */
 250         uint16_t sadb_comb_flags;               /* Comb. flags (e.g. PFS) */
 251         uint16_t sadb_comb_auth_minbits;        /* Bit strengths for auth */
 252         uint16_t sadb_comb_auth_maxbits;
 253         uint16_t sadb_comb_encrypt_minbits;     /* Bit strengths for encrypt */
 254         uint16_t sadb_comb_encrypt_maxbits;
 255         uint8_t sadb_x_comb_encrypt_saltbits;
 256         uint8_t sadb_x_comb_reserved;
 257         uint16_t sadb_comb_reserved;
 258         uint32_t sadb_comb_soft_allocations;    /* Lifetime proposals for */
 259         uint32_t sadb_comb_hard_allocations;    /* this combination. */
 260         uint64_t sadb_comb_soft_bytes;
 261         uint64_t sadb_comb_hard_bytes;
 262         uint64_t sadb_comb_soft_addtime;
 263         uint64_t sadb_comb_hard_addtime;
 264         uint64_t sadb_comb_soft_usetime;
 265         uint64_t sadb_comb_hard_usetime;
 266 } sadb_comb_t;
 267
 268 /*
 269  * An extended combination that can comprise of many SA types.
 270  * A single combination has algorithms and SA types locked.
 271  * These are represented by algorithm descriptors, the second structure
 272  * in the list.  For example, if the EACQUIRE requests AH(MD5) + ESP(DES/null)
 273  * _or_ ESP(DES/MD5), it would have two combinations:
 274  *
 275  * COMB: algdes(AH, AUTH, MD5), algdes(ESP, CRYPT, DES)
 276  * COMB: algdes(ESP, AUTH, MD5), algdes(ESP, CRYPT, DES)
 277  *
 278  * If an SA type supports an algorithm type, and there's no descriptor,
 279  * assume it requires NONE, just like it were explicitly stated.
 280  * (This includes ESP NULL encryption, BTW.)
 281  *
 282  * Already 64-bit aligned thanks to uint64_t fields.
 283  */
 284
 285 typedef struct sadb_x_ecomb {
 286         uint8_t sadb_x_ecomb_numalgs;
 287         uint8_t sadb_x_ecomb_reserved;
 288         uint16_t sadb_x_ecomb_flags;    /* E.g. PFS? */
 289         uint32_t sadb_x_ecomb_reserved2;
 290         uint32_t sadb_x_ecomb_soft_allocations;
 291         uint32_t sadb_x_ecomb_hard_allocations;
 292         uint64_t sadb_x_ecomb_soft_bytes;
 293         uint64_t sadb_x_ecomb_hard_bytes;
 294         uint64_t sadb_x_ecomb_soft_addtime;
 295         uint64_t sadb_x_ecomb_hard_addtime;
 296         uint64_t sadb_x_ecomb_soft_usetime;
 297         uint64_t sadb_x_ecomb_hard_usetime;
 298 } sadb_x_ecomb_t;
 299
 300 typedef struct sadb_x_algdesc {
 301         /* Union is for guaranteeing 64-bit alignment. */
 302         union {
 303                 struct {
 304                         uint8_t sadb_x_algdesc_usatype; /* ESP, AH, etc. */
 305                         uint8_t sadb_x_algdesc_ualgtype; /* AUTH, CRYPT, COMP */
 306                         uint8_t sadb_x_algdesc_ualg;    /* 3DES, MD5, etc. */
 307                         uint8_t sadb_x_algdesc_usaltbits;
 308                         uint16_t sadb_x_algdesc_uminbits; /* Bit strengths. */
 309                         uint16_t sadb_x_algdesc_umaxbits;
 310                 } sadb_x_algdesc_actual;
 311                 uint64_t sadb_x_algdesc_alignment;
 312         } sadb_x_algdesc_u;
 313 #define sadb_x_algdesc_satype \
 314         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_usatype
 315 #define sadb_x_algdesc_algtype \
 316         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_ualgtype
 317 #define sadb_x_algdesc_alg \
 318         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_ualg
 319 #define sadb_x_algdesc_saltbits \
 320         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_usaltbits
 321 #define sadb_x_algdesc_minbits \
 322         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_uminbits
 323 #define sadb_x_algdesc_maxbits \
 324         sadb_x_algdesc_u.sadb_x_algdesc_actual.sadb_x_algdesc_umaxbits
 325 } sadb_x_algdesc_t;
 326
 327 /*
 328  * When key mgmt. registers with the kernel, the kernel will tell key mgmt.
 329  * its supported algorithms.
 330  */
 331
 332 typedef struct sadb_supported {
 333         /* Union is for guaranteeing 64-bit alignment. */
 334         union {
 335                 struct {
 336                         uint16_t sadb_x_supported_ulen;
 337                         uint16_t sadb_x_supported_uexttype;
 338                         uint32_t sadb_x_supported_ureserved;
 339                 } sadb_x_supported_actual;
 340                 uint64_t sadb_x_supported_alignment;
 341         } sadb_x_supported_u;
 342 #define sadb_supported_len \
 343         sadb_x_supported_u.sadb_x_supported_actual.sadb_x_supported_ulen
 344 #define sadb_supported_exttype \
 345         sadb_x_supported_u.sadb_x_supported_actual.sadb_x_supported_uexttype
 346 #define sadb_supported_reserved \
 347         sadb_x_supported_u.sadb_x_supported_actual.sadb_x_supported_ureserved
 348 } sadb_supported_t;
 349
 350 /* First, a base structure... */
 351 typedef struct sadb_x_algb {
 352         uint8_t sadb_x_algb_id;         /* Algorithm type. */
 353         uint8_t sadb_x_algb_ivlen;              /* IV len, in bits */
 354         uint16_t sadb_x_algb_minbits;   /* Min. key len (in bits) */
 355         uint16_t sadb_x_algb_maxbits;   /* Max. key length */
 356         union {
 357                 uint16_t sadb_x_algb_ureserved;
 358                 uint8_t sadb_x_algb_udefaults[2];
 359         } sadb_x_algb_union;
 360
 361 #define sadb_x_algb_reserved sadb_x_algb_union.sadb_x_algb_ureserved
 362 #define sadb_x_algb_increment sadb_x_algb_union.sadb_x_algb_udefaults[0]
 363 #define sadb_x_algb_saltbits sadb_x_algb_union.sadb_x_algb_udefaults[1]
 364 /*
 365  * alg_increment: the number of bits from a key length to the next
 366  */
 367 } sadb_x_algb_t;
 368
 369 /* Now, the actual sadb_alg structure, which will have alignment in it. */
 370 typedef struct sadb_alg {
 371         /* Union is for guaranteeing 64-bit alignment. */
 372         union {
 373                 sadb_x_algb_t sadb_x_alg_actual;
 374                 uint64_t sadb_x_alg_alignment;
 375         } sadb_x_alg_u;
 376 #define sadb_alg_id sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_id
 377 #define sadb_alg_ivlen sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_ivlen
 378 #define sadb_alg_minbits sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_minbits
 379 #define sadb_alg_maxbits sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_maxbits
 380 #define sadb_alg_reserved sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_reserved
 381 #define sadb_x_alg_increment \
 382         sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_increment
 383 #define sadb_x_alg_saltbits sadb_x_alg_u.sadb_x_alg_actual.sadb_x_algb_saltbits
 384 } sadb_alg_t;
 385
 386 /*
 387  * If key mgmt. needs an SPI in a range (including 0 to 0xFFFFFFFF), it
 388  * asks the kernel with this extension in the SADB_GETSPI message.
 389  */
 390
 391 typedef struct sadb_spirange {
 392         uint16_t sadb_spirange_len;
 393         uint16_t sadb_spirange_exttype; /* SPI_RANGE */
 394         uint32_t sadb_spirange_min;
 395         /* Union is for guaranteeing 64-bit alignment. */
 396         union {
 397                 struct {
 398                         uint32_t sadb_x_spirange_umax;
 399                         uint32_t sadb_x_spirange_ureserved;
 400                 } sadb_x_spirange_actual;
 401                 uint64_t sadb_x_spirange_alignment;
 402         } sadb_x_spirange_u;
 403 #define sadb_spirange_max \
 404         sadb_x_spirange_u.sadb_x_spirange_actual.sadb_x_spirange_umax
 405 #define sadb_spirange_reserved \
 406         sadb_x_spirange_u.sadb_x_spirange_actual.sadb_x_spirange_ureserved
 407 } sadb_spirange_t;
 408
 409 /*
 410  * For the "extended REGISTER" which'll tell the kernel to send me
 411  * "extended ACQUIREs".
 412  */
 413
 414 typedef struct sadb_x_ereg {
 415         /* Union is for guaranteeing 64-bit alignment. */
 416         union {
 417                 struct {
 418                         uint16_t sadb_x_ereg_ulen;
 419                         uint16_t sadb_x_ereg_uexttype;  /* X_EREG */
 420                         /* Array of SA types, 0-terminated. */
 421                         uint8_t sadb_x_ereg_usatypes[4];
 422                 } sadb_x_ereg_actual;
 423                 uint64_t sadb_x_ereg_alignment;
 424         } sadb_x_ereg_u;
 425 #define sadb_x_ereg_len \
 426         sadb_x_ereg_u.sadb_x_ereg_actual.sadb_x_ereg_ulen
 427 #define sadb_x_ereg_exttype \
 428         sadb_x_ereg_u.sadb_x_ereg_actual.sadb_x_ereg_uexttype
 429 #define sadb_x_ereg_satypes \
 430         sadb_x_ereg_u.sadb_x_ereg_actual.sadb_x_ereg_usatypes
 431 } sadb_x_ereg_t;
 432
 433 /*
 434  * For conveying a Key Management Cookie with SADB_GETSPI, SADB_ADD,
 435  * SADB_ACQUIRE, or SADB_X_INVERSE_ACQUIRE.
 436  */
 437
 438 typedef struct sadb_x_kmc {
 439         uint16_t sadb_x_kmc_len;
 440         uint16_t sadb_x_kmc_exttype;    /* X_KM_COOKIE */
 441         uint32_t sadb_x_kmc_proto;      /* KM protocol */
 442         union {
 443                 struct {
 444                         uint32_t sadb_x_kmc_ucookie;    /* KMP-specific */
 445                         uint32_t sadb_x_kmc_ureserved;  /* Must be zero */
 446                 } sadb_x_kmc_actual;
 447                 uint64_t sadb_x_kmc_ucookie64;
 448         } sadb_x_kmc_u;
 449 #define sadb_x_kmc_cookie sadb_x_kmc_u.sadb_x_kmc_actual.sadb_x_kmc_ucookie
 450 #define sadb_x_kmc_reserved sadb_x_kmc_u.sadb_x_kmc_actual.sadb_x_kmc_ureserved
 451 #define sadb_x_kmc_cookie64 sadb_x_kmc_u.sadb_x_kmc_ucookie64
 452 } sadb_x_kmc_t;
 453
 454 typedef struct sadb_x_pair {
 455         union {
 456                 /* Union is for guaranteeing 64-bit alignment. */
 457                 struct {
 458                         uint16_t sadb_x_pair_ulen;
 459                         uint16_t sadb_x_pair_uexttype;
 460                         uint32_t sadb_x_pair_uspi;      /* SPI of paired SA */
 461                 } sadb_x_pair_actual;
 462                 uint64_t sadb_x_ext_alignment;
 463         } sadb_x_pair_u;
 464 #define sadb_x_pair_len sadb_x_pair_u.sadb_x_pair_actual.sadb_x_pair_ulen
 465 #define sadb_x_pair_exttype \
 466         sadb_x_pair_u.sadb_x_pair_actual.sadb_x_pair_uexttype
 467 #define sadb_x_pair_spi sadb_x_pair_u.sadb_x_pair_actual.sadb_x_pair_uspi
 468 } sadb_x_pair_t;
 469
 470 /*
 471  * For the Sequence numbers to be used with SADB_DUMP, SADB_GET, SADB_UPDATE.
 472  */
 473
 474 typedef struct sadb_x_replay_ctr {
 475         uint16_t sadb_x_rc_len;
 476         uint16_t sadb_x_rc_exttype;
 477         uint32_t sadb_x_rc_replay32;    /* For 240x SAs. */
 478         uint64_t sadb_x_rc_replay64;    /* For 430x SAs. */
 479 } sadb_x_replay_ctr_t;
 480
 481 /*
 482  * For extended DUMP request. Dumps the SAs which were idle for
 483  * longer than the timeout specified.
 484  */
 485
 486 typedef struct sadb_x_edump {
 487         uint16_t sadb_x_edump_len;
 488         uint16_t sadb_x_edump_exttype;
 489         uint32_t sadb_x_edump_reserved;
 490         uint64_t sadb_x_edump_timeout;
 491 } sadb_x_edump_t;
 492
 493 /*
 494  * Base message types.
 495  */
 496
 497 #define SADB_RESERVED   0
 498 #define SADB_GETSPI     1
 499 #define SADB_UPDATE     2
 500 #define SADB_ADD        3
 501 #define SADB_DELETE     4
 502 #define SADB_GET        5
 503 #define SADB_ACQUIRE    6
 504 #define SADB_REGISTER   7
 505 #define SADB_EXPIRE     8
 506 #define SADB_FLUSH      9
 507 #define SADB_DUMP       10   /* not used normally */
 508 #define SADB_X_PROMISC  11
 509 #define SADB_X_INVERSE_ACQUIRE  12
 510 #define SADB_X_UPDATEPAIR       13
 511 #define SADB_X_DELPAIR          14
 512 #define SADB_X_DELPAIR_STATE    15
 513 #define SADB_MAX                15
 514
 515 /*
 516  * SA flags
 517  */
 518
 519 #define SADB_SAFLAGS_PFS        0x1     /* Perfect forward secrecy? */
 520 #define SADB_SAFLAGS_NOREPLAY   0x2     /* Replay field NOT PRESENT. */
 521
 522 /* Below flags are used by this implementation.  Grow from left-to-right. */
 523 #define SADB_X_SAFLAGS_USED     0x80000000      /* SA used/not used */
 524 #define SADB_X_SAFLAGS_UNIQUE   0x40000000      /* SA unique/reusable */
 525 #define SADB_X_SAFLAGS_AALG1    0x20000000      /* Auth-alg specific flag 1 */
 526 #define SADB_X_SAFLAGS_AALG2    0x10000000      /* Auth-alg specific flag 2 */
 527 #define SADB_X_SAFLAGS_EALG1     0x8000000      /* Encr-alg specific flag 1 */
 528 #define SADB_X_SAFLAGS_EALG2     0x4000000      /* Encr-alg specific flag 2 */
 529 #define SADB_X_SAFLAGS_KM1       0x2000000      /* Key mgmt. specific flag 1 */
 530 #define SADB_X_SAFLAGS_KM2       0x1000000      /* Key mgmt. specific flag 2 */
 531 #define SADB_X_SAFLAGS_KM3        0x800000      /* Key mgmt. specific flag 3 */
 532 #define SADB_X_SAFLAGS_KM4        0x400000      /* Key mgmt. specific flag 4 */
 533 #define SADB_X_SAFLAGS_KRES1      0x200000      /* Reserved by the kernel */
 534 #define SADB_X_SAFLAGS_NATT_LOC   0x100000      /* this has a natted src SA */
 535 #define SADB_X_SAFLAGS_NATT_REM    0x80000      /* this has a natted dst SA */
 536 #define SADB_X_SAFLAGS_KRES2       0x40000      /* Reserved by the kernel */
 537 #define SADB_X_SAFLAGS_TUNNEL      0x20000      /* tunnel mode */
 538 #define SADB_X_SAFLAGS_PAIRED      0x10000      /* inbound/outbound pair */
 539 #define SADB_X_SAFLAGS_OUTBOUND     0x8000      /* SA direction bit */
 540 #define SADB_X_SAFLAGS_INBOUND      0x4000      /* SA direction bit */
 541 #define SADB_X_SAFLAGS_NATTED       0x1000      /* Local node is behind a NAT */
 542
 543 #define SADB_X_SAFLAGS_KRES     \
 544         SADB_X_SAFLAGS_KRES1 | SADB_X_SAFLAGS_KRES2
 545
 546 /*
 547  * SA state.
 548  */
 549
 550 #define SADB_SASTATE_LARVAL             0
 551 #define SADB_SASTATE_MATURE             1
 552 #define SADB_SASTATE_DYING              2
 553 #define SADB_SASTATE_DEAD               3
 554 #define SADB_X_SASTATE_ACTIVE_ELSEWHERE 4
 555 #define SADB_X_SASTATE_IDLE             5
 556 #define SADB_X_SASTATE_ACTIVE           6
 557
 558 #define SADB_SASTATE_MAX                6
 559
 560 /*
 561  * SA type.  Gaps are present in the number space because (for the time being)
 562  * these types correspond to the SA types in the IPsec DOI document.
 563  */
 564
 565 #define SADB_SATYPE_UNSPEC      0
 566 #define SADB_SATYPE_AH          2  /* RFC-1826 */
 567 #define SADB_SATYPE_ESP         3  /* RFC-1827 */
 568 #define SADB_SATYPE_RSVP        5  /* RSVP Authentication */
 569 #define SADB_SATYPE_OSPFV2      6  /* OSPFv2 Authentication */
 570 #define SADB_SATYPE_RIPV2       7  /* RIPv2 Authentication */
 571 #define SADB_SATYPE_MIP         8  /* Mobile IPv4 Authentication */
 572
 573 #define SADB_SATYPE_MAX         8
 574
 575 /*
 576  * Algorithm types.  Gaps are present because (for the time being) these types
 577  * correspond to the SA types in the IPsec DOI document.
 578  *
 579  * NOTE:  These are numbered to play nice with the IPsec DOI.  That's why
 580  *        there are gaps.
 581  */
 582
 583 /* Authentication algorithms */
 584 #define SADB_AALG_NONE          0
 585 #define SADB_AALG_MD5HMAC       2
 586 #define SADB_AALG_SHA1HMAC      3
 587 #define SADB_AALG_SHA256HMAC    5
 588 #define SADB_AALG_SHA384HMAC    6
 589 #define SADB_AALG_SHA512HMAC    7
 590
 591 #define SADB_AALG_MAX           7
 592
 593 /* Encryption algorithms */
 594 #define SADB_EALG_NONE          0
 595 #define SADB_EALG_DESCBC        2
 596 #define SADB_EALG_3DESCBC       3
 597 #define SADB_EALG_BLOWFISH      7
 598 #define SADB_EALG_NULL          11
 599 #define SADB_EALG_AES           12
 600 #define SADB_EALG_AES_CCM_8     14
 601 #define SADB_EALG_AES_CCM_12    15
 602 #define SADB_EALG_AES_CCM_16    16
 603 #define SADB_EALG_AES_GCM_8     18
 604 #define SADB_EALG_AES_GCM_12    19
 605 #define SADB_EALG_AES_GCM_16    20
 606 #define SADB_EALG_MAX           20
 607
 608 /*
 609  * Extension header values.
 610  */
 611
 612 #define SADB_EXT_RESERVED               0
 613
 614 #define SADB_EXT_SA                     1
 615 #define SADB_EXT_LIFETIME_CURRENT       2
 616 #define SADB_EXT_LIFETIME_HARD          3
 617 #define SADB_EXT_LIFETIME_SOFT          4
 618 #define SADB_EXT_ADDRESS_SRC            5
 619 #define SADB_EXT_ADDRESS_DST            6
 620 /* These two are synonyms. */
 621 #define SADB_EXT_ADDRESS_PROXY          7
 622 #define SADB_X_EXT_ADDRESS_INNER_SRC    SADB_EXT_ADDRESS_PROXY
 623 #define SADB_EXT_KEY_AUTH               8
 624 #define SADB_EXT_KEY_ENCRYPT            9
 625 #define SADB_EXT_IDENTITY_SRC           10
 626 #define SADB_EXT_IDENTITY_DST           11
 627 #define SADB_EXT_SENSITIVITY            12
 628 #define SADB_EXT_PROPOSAL               13
 629 #define SADB_EXT_SUPPORTED_AUTH         14
 630 #define SADB_EXT_SUPPORTED_ENCRYPT      15
 631 #define SADB_EXT_SPIRANGE               16
 632 #define SADB_X_EXT_EREG                 17
 633 #define SADB_X_EXT_EPROP                18
 634 #define SADB_X_EXT_KM_COOKIE            19
 635 #define SADB_X_EXT_ADDRESS_NATT_LOC     20
 636 #define SADB_X_EXT_ADDRESS_NATT_REM     21
 637 #define SADB_X_EXT_ADDRESS_INNER_DST    22
 638 #define SADB_X_EXT_PAIR                 23
 639 #define SADB_X_EXT_REPLAY_VALUE         24
 640 #define SADB_X_EXT_EDUMP                25
 641 #define SADB_X_EXT_LIFETIME_IDLE        26
 642 #define SADB_X_EXT_OUTER_SENS           27
 643
 644 #define SADB_EXT_MAX                    27
 645
 646 /*
 647  * Identity types.
 648  */
 649
 650 #define SADB_IDENTTYPE_RESERVED 0
 651
 652 /*
 653  * For PREFIX and ADDR_RANGE, use the AF of the PROXY if present, or the SRC
 654  * if not present.
 655  */
 656 #define SADB_IDENTTYPE_PREFIX           1
 657 #define SADB_IDENTTYPE_FQDN             2  /* Fully qualified domain name. */
 658 #define SADB_IDENTTYPE_USER_FQDN        3  /* e.g. root@domain.com */
 659 #define SADB_X_IDENTTYPE_DN             4  /* ASN.1 DER Distinguished Name. */
 660 #define SADB_X_IDENTTYPE_GN             5  /* ASN.1 DER Generic Name. */
 661 #define SADB_X_IDENTTYPE_KEY_ID         6  /* Generic KEY ID. */
 662 #define SADB_X_IDENTTYPE_ADDR_RANGE     7
 663
 664 #define SADB_IDENTTYPE_MAX      7
 665
 666 /*
 667  * Protection DOI values for the SENSITIVITY extension.  There are no values
 668  * currently, so the MAX is the only non-zero value available.
 669  */
 670
 671 #define SADB_DPD_NONE   0
 672
 673 #define SADB_DPD_MAX    1
 674
 675 /*
 676  * Diagnostic codes.  These supplement error messages.  Be sure to
 677  * update libipsecutil's keysock_diag() if you change any of these.
 678  */
 679
 680 #define SADB_X_DIAGNOSTIC_PRESET                -1      /* Internal value. */
 681
 682 #define SADB_X_DIAGNOSTIC_NONE                  0
 683
 684 #define SADB_X_DIAGNOSTIC_UNKNOWN_MSG           1
 685 #define SADB_X_DIAGNOSTIC_UNKNOWN_EXT           2
 686 #define SADB_X_DIAGNOSTIC_BAD_EXTLEN            3
 687 #define SADB_X_DIAGNOSTIC_UNKNOWN_SATYPE        4
 688 #define SADB_X_DIAGNOSTIC_SATYPE_NEEDED         5
 689 #define SADB_X_DIAGNOSTIC_NO_SADBS              6
 690 #define SADB_X_DIAGNOSTIC_NO_EXT                7
 691 /* Bad address family value */
 692 #define SADB_X_DIAGNOSTIC_BAD_SRC_AF            8
 693 /* in sockaddr->sa_family. */
 694 #define SADB_X_DIAGNOSTIC_BAD_DST_AF            9
 695 /* These two are synonyms. */
 696 #define SADB_X_DIAGNOSTIC_BAD_PROXY_AF          10
 697 #define SADB_X_DIAGNOSTIC_BAD_INNER_SRC_AF      10
 698
 699 #define SADB_X_DIAGNOSTIC_AF_MISMATCH           11
 700
 701 #define SADB_X_DIAGNOSTIC_BAD_SRC               12
 702 #define SADB_X_DIAGNOSTIC_BAD_DST               13
 703
 704 #define SADB_X_DIAGNOSTIC_ALLOC_HSERR           14
 705 #define SADB_X_DIAGNOSTIC_BYTES_HSERR           15
 706 #define SADB_X_DIAGNOSTIC_ADDTIME_HSERR         16
 707 #define SADB_X_DIAGNOSTIC_USETIME_HSERR         17
 708
 709 #define SADB_X_DIAGNOSTIC_MISSING_SRC           18
 710 #define SADB_X_DIAGNOSTIC_MISSING_DST           19
 711 #define SADB_X_DIAGNOSTIC_MISSING_SA            20
 712 #define SADB_X_DIAGNOSTIC_MISSING_EKEY          21
 713 #define SADB_X_DIAGNOSTIC_MISSING_AKEY          22
 714 #define SADB_X_DIAGNOSTIC_MISSING_RANGE         23
 715
 716 #define SADB_X_DIAGNOSTIC_DUPLICATE_SRC         24
 717 #define SADB_X_DIAGNOSTIC_DUPLICATE_DST         25
 718 #define SADB_X_DIAGNOSTIC_DUPLICATE_SA          26
 719 #define SADB_X_DIAGNOSTIC_DUPLICATE_EKEY        27
 720 #define SADB_X_DIAGNOSTIC_DUPLICATE_AKEY        28
 721 #define SADB_X_DIAGNOSTIC_DUPLICATE_RANGE       29
 722
 723 #define SADB_X_DIAGNOSTIC_MALFORMED_SRC         30
 724 #define SADB_X_DIAGNOSTIC_MALFORMED_DST         31
 725 #define SADB_X_DIAGNOSTIC_MALFORMED_SA          32
 726 #define SADB_X_DIAGNOSTIC_MALFORMED_EKEY        33
 727 #define SADB_X_DIAGNOSTIC_MALFORMED_AKEY        34
 728 #define SADB_X_DIAGNOSTIC_MALFORMED_RANGE       35
 729
 730 #define SADB_X_DIAGNOSTIC_AKEY_PRESENT          36
 731 #define SADB_X_DIAGNOSTIC_EKEY_PRESENT          37
 732 #define SADB_X_DIAGNOSTIC_PROP_PRESENT          38
 733 #define SADB_X_DIAGNOSTIC_SUPP_PRESENT          39
 734
 735 #define SADB_X_DIAGNOSTIC_BAD_AALG              40
 736 #define SADB_X_DIAGNOSTIC_BAD_EALG              41
 737 #define SADB_X_DIAGNOSTIC_BAD_SAFLAGS           42
 738 #define SADB_X_DIAGNOSTIC_BAD_SASTATE           43
 739
 740 #define SADB_X_DIAGNOSTIC_BAD_AKEYBITS          44
 741 #define SADB_X_DIAGNOSTIC_BAD_EKEYBITS          45
 742
 743 #define SADB_X_DIAGNOSTIC_ENCR_NOTSUPP          46
 744
 745 #define SADB_X_DIAGNOSTIC_WEAK_EKEY             47
 746 #define SADB_X_DIAGNOSTIC_WEAK_AKEY             48
 747
 748 #define SADB_X_DIAGNOSTIC_DUPLICATE_KMP         49
 749 #define SADB_X_DIAGNOSTIC_DUPLICATE_KMC         50
 750
 751 #define SADB_X_DIAGNOSTIC_MISSING_NATT_LOC      51
 752 #define SADB_X_DIAGNOSTIC_MISSING_NATT_REM      52
 753 #define SADB_X_DIAGNOSTIC_DUPLICATE_NATT_LOC    53
 754 #define SADB_X_DIAGNOSTIC_DUPLICATE_NATT_REM    54
 755 #define SADB_X_DIAGNOSTIC_MALFORMED_NATT_LOC    55
 756 #define SADB_X_DIAGNOSTIC_MALFORMED_NATT_REM    56
 757 #define SADB_X_DIAGNOSTIC_DUPLICATE_NATT_PORTS  57
 758
 759 #define SADB_X_DIAGNOSTIC_MISSING_INNER_SRC     58
 760 #define SADB_X_DIAGNOSTIC_MISSING_INNER_DST     59
 761 #define SADB_X_DIAGNOSTIC_DUPLICATE_INNER_SRC   60
 762 #define SADB_X_DIAGNOSTIC_DUPLICATE_INNER_DST   61
 763 #define SADB_X_DIAGNOSTIC_MALFORMED_INNER_SRC   62
 764 #define SADB_X_DIAGNOSTIC_MALFORMED_INNER_DST   63
 765
 766 #define SADB_X_DIAGNOSTIC_PREFIX_INNER_SRC      64
 767 #define SADB_X_DIAGNOSTIC_PREFIX_INNER_DST      65
 768 #define SADB_X_DIAGNOSTIC_BAD_INNER_DST_AF      66
 769 #define SADB_X_DIAGNOSTIC_INNER_AF_MISMATCH     67
 770
 771 #define SADB_X_DIAGNOSTIC_BAD_NATT_REM_AF       68
 772 #define SADB_X_DIAGNOSTIC_BAD_NATT_LOC_AF       69
 773
 774 #define SADB_X_DIAGNOSTIC_PROTO_MISMATCH        70
 775 #define SADB_X_DIAGNOSTIC_INNER_PROTO_MISMATCH  71
 776
 777 #define SADB_X_DIAGNOSTIC_DUAL_PORT_SETS        72
 778
 779 #define SADB_X_DIAGNOSTIC_PAIR_INAPPROPRIATE    73
 780 #define SADB_X_DIAGNOSTIC_PAIR_ADD_MISMATCH     74
 781 #define SADB_X_DIAGNOSTIC_PAIR_ALREADY          75
 782 #define SADB_X_DIAGNOSTIC_PAIR_SA_NOTFOUND      76
 783 #define SADB_X_DIAGNOSTIC_BAD_SA_DIRECTION      77
 784
 785 #define SADB_X_DIAGNOSTIC_SA_NOTFOUND           78
 786 #define SADB_X_DIAGNOSTIC_SA_EXPIRED            79
 787 #define SADB_X_DIAGNOSTIC_BAD_CTX               80
 788 #define SADB_X_DIAGNOSTIC_INVALID_REPLAY        81
 789 #define SADB_X_DIAGNOSTIC_MISSING_LIFETIME      82
 790
 791 #define SADB_X_DIAGNOSTIC_BAD_LABEL             83
 792 #define SADB_X_DIAGNOSTIC_MAX                   83
 793
 794 /* Algorithm type for sadb_x_algdesc above... */
 795
 796 #define SADB_X_ALGTYPE_NONE             0
 797 #define SADB_X_ALGTYPE_AUTH             1
 798 #define SADB_X_ALGTYPE_CRYPT            2
 799 #define SADB_X_ALGTYPE_COMPRESS         3
 800
 801 #define SADB_X_ALGTYPE_MAX              3
 802
 803 /* Key management protocol for sadb_x_kmc above... */
 804
 805 #define SADB_X_KMP_MANUAL       0       /* Cookie is ignored. */
 806 #define SADB_X_KMP_IKE          1
 807 #define SADB_X_KMP_KINK         2
 808 #define SADB_X_KMP_IKEV2        3
 809
 810 #define SADB_X_KMP_MAX          SADB_X_KMP_IKEV2
 811
 812 /*
 813  * Handy conversion macros.  Not part of the PF_KEY spec...
 814  */
 815
 816 #define SADB_64TO8(x)   ((x) << 3)
 817 #define SADB_8TO64(x)   ((x) >> 3)
 818 #define SADB_8TO1(x)    ((x) << 3)
 819 #define SADB_1TO8(x)    ((x) >> 3)
 820
 821 #ifdef  __cplusplus
 822 }
 823 #endif
 824
 825 #endif  /* _NET_PFKEYV2_H */