include/uapi/linux/rxrpc.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later WITH Linux-syscall-note */
   2 /* Types and definitions for AF_RXRPC.
   3  *
   4  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
   5  * Written by David Howells (dhowells@redhat.com)
   6  */
   7
   8 #ifndef _UAPI_LINUX_RXRPC_H
   9 #define _UAPI_LINUX_RXRPC_H
  10
  11 #include <linux/types.h>
  12 #include <linux/in.h>
  13 #include <linux/in6.h>
  14
  15 /*
  16  * RxRPC socket address
  17  */
  18 struct sockaddr_rxrpc {
  19         __kernel_sa_family_t    srx_family;     /* address family */
  20         __u16                   srx_service;    /* service desired */
  21         __u16                   transport_type; /* type of transport socket (SOCK_DGRAM) */
  22         __u16                   transport_len;  /* length of transport address */
  23         union {
  24                 __kernel_sa_family_t family;    /* transport address family */
  25                 struct sockaddr_in sin;         /* IPv4 transport address */
  26                 struct sockaddr_in6 sin6;       /* IPv6 transport address */
  27         } transport;
  28 };
  29
  30 /*
  31  * RxRPC socket options
  32  */
  33 #define RXRPC_SECURITY_KEY              1       /* [clnt] set client security key */
  34 #define RXRPC_SECURITY_KEYRING          2       /* [srvr] set ring of server security keys */
  35 #define RXRPC_EXCLUSIVE_CONNECTION      3       /* Deprecated; use RXRPC_EXCLUSIVE_CALL instead */
  36 #define RXRPC_MIN_SECURITY_LEVEL        4       /* minimum security level */
  37 #define RXRPC_UPGRADEABLE_SERVICE       5       /* Upgrade service[0] -> service[1] */
  38 #define RXRPC_SUPPORTED_CMSG            6       /* Get highest supported control message type */
  39
  40 /*
  41  * RxRPC control messages
  42  * - If neither abort or accept are specified, the message is a data message.
  43  * - terminal messages mean that a user call ID tag can be recycled
  44  * - s/r/- indicate whether these are applicable to sendmsg() and/or recvmsg()
  45  */
  46 enum rxrpc_cmsg_type {
  47         RXRPC_USER_CALL_ID      = 1,    /* sr: user call ID specifier */
  48         RXRPC_ABORT             = 2,    /* sr: abort request / notification [terminal] */
  49         RXRPC_ACK               = 3,    /* -r: [Service] RPC op final ACK received [terminal] */
  50         RXRPC_NET_ERROR         = 5,    /* -r: network error received [terminal] */
  51         RXRPC_BUSY              = 6,    /* -r: server busy received [terminal] */
  52         RXRPC_LOCAL_ERROR       = 7,    /* -r: local error generated [terminal] */
  53         RXRPC_NEW_CALL          = 8,    /* -r: [Service] new incoming call notification */
  54         RXRPC_EXCLUSIVE_CALL    = 10,   /* s-: Call should be on exclusive connection */
  55         RXRPC_UPGRADE_SERVICE   = 11,   /* s-: Request service upgrade for client call */
  56         RXRPC_TX_LENGTH         = 12,   /* s-: Total length of Tx data */
  57         RXRPC_SET_CALL_TIMEOUT  = 13,   /* s-: Set one or more call timeouts */
  58         RXRPC_CHARGE_ACCEPT     = 14,   /* s-: Charge the accept pool with a user call ID */
  59         RXRPC__SUPPORTED
  60 };
  61
  62 /*
  63  * RxRPC security levels
  64  */
  65 #define RXRPC_SECURITY_PLAIN    0       /* plain secure-checksummed packets only */
  66 #define RXRPC_SECURITY_AUTH     1       /* authenticated packets */
  67 #define RXRPC_SECURITY_ENCRYPT  2       /* encrypted packets */
  68
  69 /*
  70  * RxRPC security indices
  71  */
  72 #define RXRPC_SECURITY_NONE     0       /* no security protocol */
  73 #define RXRPC_SECURITY_RXKAD    2       /* kaserver or kerberos 4 */
  74 #define RXRPC_SECURITY_RXGK     4       /* gssapi-based */
  75 #define RXRPC_SECURITY_RXK5     5       /* kerberos 5 */
  76
  77 /*
  78  * RxRPC-level abort codes
  79  */
  80 #define RX_CALL_DEAD            -1      /* call/conn has been inactive and is shut down */
  81 #define RX_INVALID_OPERATION    -2      /* invalid operation requested / attempted */
  82 #define RX_CALL_TIMEOUT         -3      /* call timeout exceeded */
  83 #define RX_EOF                  -4      /* unexpected end of data on read op */
  84 #define RX_PROTOCOL_ERROR       -5      /* low-level protocol error */
  85 #define RX_USER_ABORT           -6      /* generic user abort */
  86 #define RX_ADDRINUSE            -7      /* UDP port in use */
  87 #define RX_DEBUGI_BADTYPE       -8      /* bad debugging packet type */
  88
  89 /*
  90  * (un)marshalling abort codes (rxgen)
  91  */
  92 #define RXGEN_CC_MARSHAL        -450
  93 #define RXGEN_CC_UNMARSHAL      -451
  94 #define RXGEN_SS_MARSHAL        -452
  95 #define RXGEN_SS_UNMARSHAL      -453
  96 #define RXGEN_DECODE            -454
  97 #define RXGEN_OPCODE            -455
  98 #define RXGEN_SS_XDRFREE        -456
  99 #define RXGEN_CC_XDRFREE        -457
 100
 101 /*
 102  * Rx kerberos security abort codes
 103  * - unfortunately we have no generalised security abort codes to say things
 104  *   like "unsupported security", so we have to use these instead and hope the
 105  *   other side understands
 106  */
 107 #define RXKADINCONSISTENCY      19270400        /* security module structure inconsistent */
 108 #define RXKADPACKETSHORT        19270401        /* packet too short for security challenge */
 109 #define RXKADLEVELFAIL          19270402        /* security level negotiation failed */
 110 #define RXKADTICKETLEN          19270403        /* ticket length too short or too long */
 111 #define RXKADOUTOFSEQUENCE      19270404        /* packet had bad sequence number */
 112 #define RXKADNOAUTH             19270405        /* caller not authorised */
 113 #define RXKADBADKEY             19270406        /* illegal key: bad parity or weak */
 114 #define RXKADBADTICKET          19270407        /* security object was passed a bad ticket */
 115 #define RXKADUNKNOWNKEY         19270408        /* ticket contained unknown key version number */
 116 #define RXKADEXPIRED            19270409        /* authentication expired */
 117 #define RXKADSEALEDINCON        19270410        /* sealed data inconsistent */
 118 #define RXKADDATALEN            19270411        /* user data too long */
 119 #define RXKADILLEGALLEVEL       19270412        /* caller not authorised to use encrypted conns */
 120
 121 #endif /* _UAPI_LINUX_RXRPC_H */