contrib/openbsm/libbsm/au_token.3

   1 .\"-
   2 .\" Copyright (c) 2005-2007 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd April 19, 2005
  27 .Dt AU_TOKEN 3
  28 .Os
  29 .Sh NAME
  30 .Nm au_to_arg32 ,
  31 .Nm au_to_arg64 ,
  32 .Nm au_to_arg ,
  33 .Nm au_to_attr64 ,
  34 .Nm au_to_data ,
  35 .Nm au_to_exit ,
  36 .Nm au_to_groups ,
  37 .Nm au_to_newgroups ,
  38 .Nm au_to_in_addr ,
  39 .Nm au_to_in_addr_ex ,
  40 .Nm au_to_ip ,
  41 .Nm au_to_ipc ,
  42 .Nm au_to_ipc_perm ,
  43 .Nm au_to_iport ,
  44 .Nm au_to_opaque ,
  45 .Nm au_to_file ,
  46 .Nm au_to_text ,
  47 .Nm au_to_path ,
  48 .Nm au_to_process32 ,
  49 .Nm au_to_process64 ,
  50 .Nm au_to_process ,
  51 .Nm au_to_process32_ex ,
  52 .Nm au_to_process64_ex ,
  53 .Nm au_to_process_ex ,
  54 .Nm au_to_return32 ,
  55 .Nm au_to_return64 ,
  56 .Nm au_to_return ,
  57 .Nm au_to_seq ,
  58 .Nm au_to_sock_inet32 ,
  59 .Nm au_to_sock_inet128 ,
  60 .Nm au_to_sock_inet ,
  61 .Nm au_to_socket_ex ,
  62 .Nm au_to_subject32 ,
  63 .Nm au_to_subject64 ,
  64 .Nm au_to_subject ,
  65 .Nm au_to_subject32_ex ,
  66 .Nm au_to_subject64_ex ,
  67 .Nm au_to_subject_ex ,
  68 .Nm au_to_me ,
  69 .Nm au_to_exec_args ,
  70 .Nm au_to_exec_env ,
  71 .Nm au_to_header ,
  72 .Nm au_to_header32 ,
  73 .Nm au_to_header64 ,
  74 .Nm au_to_header_ex ,
  75 .Nm au_to_header32_ex ,
  76 .Nm au_to_trailer ,
  77 .Nm au_to_zonename
  78 .Nd "routines for generating BSM audit tokens"
  79 .Sh LIBRARY
  80 .Lb libbsm
  81 .Sh SYNOPSIS
  82 .In bsm/libbsm.h
  83 .Ft "token_t *"
  84 .Fn au_to_arg32 "char n" "const char *text" "u_int32_t v"
  85 .Ft "token_t *"
  86 .Fn au_to_arg64 "char n" "const char *text" "u_int64_t v"
  87 .Ft "token_t *"
  88 .Fn au_to_arg "char n" "const char *text" "u_int32_t v"
  89 .Ft "token_t *"
  90 .Fn au_to_attr32 "struct vattr *attr"
  91 .Ft "token_t *"
  92 .Fn au_to_attr64 "struct vattr *attr"
  93 .Ft "token_t *"
  94 .Fn au_to_attr "struct vattr *attr"
  95 .Ft "token_t *"
  96 .Fn au_to_data "char unit_print" "char unit_type" "char unit_count" "const char *p"
  97 .Ft "token_t *"
  98 .Fn au_to_exit "int retval" "int err"
  99 .Ft "token_t *"
 100 .Fn au_to_groups "int *groups"
 101 .Ft "token_t *"
 102 .Fn au_to_newgroups "u_int16_t n" "gid_t *groups"
 103 .Ft "token_t *"
 104 .Fn au_to_in_addr "struct in_addr *internet_addr"
 105 .Ft "token_t *"
 106 .Fn au_to_in_addr_ex "struct in6_addr *internet_addr"
 107 .Ft "token_t *"
 108 .Fn au_to_ip "struct ip *ip"
 109 .Ft "token_t *"
 110 .Fn au_to_ipc "char type" "int id"
 111 .Ft "token_t *"
 112 .Fn au_to_ipc_perm "struct ipc_perm *perm"
 113 .Ft "token_t *"
 114 .Fn au_to_iport "u_int16_t iport"
 115 .Ft "token_t *"
 116 .Fn au_to_opaque "const char *data" "u_int16_t bytes"
 117 .Ft "token_t *"
 118 .Fn au_to_file "const char *file" "struct timeval tm"
 119 .Ft "token_t *"
 120 .Fn au_to_text "const char *text"
 121 .Ft "token_t *"
 122 .Fn au_to_path "const char *text"
 123 .Ft "token_t *"
 124 .Fo au_to_process32
 125 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 126 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 127 .Fc
 128 .Ft "token_t *"
 129 .Fo au_to_process64
 130 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 131 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 132 .Fc
 133 .Ft "token_t *"
 134 .Fo au_to_process32_ex
 135 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 136 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 137 .Fc
 138 .Ft "token_t *"
 139 .Fo au_to_process64_ex
 140 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 141 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 142 .Fc
 143 .Ft "token_t *"
 144 .Fn au_to_return32 "char status" "u_int32_t ret"
 145 .Ft "token_t *"
 146 .Fn au_to_return64 "char status" "u_int64_t ret"
 147 .Ft "token_t *"
 148 .Fn au_to_return "char status" "u_int32_t ret"
 149 .Ft "token_t *"
 150 .Fn au_to_seq "long audit_count"
 151 .Ft "token_t *"
 152 .Fn au_to_sock_inet32 "struct sockaddr_in *so"
 153 .Ft "token_t *"
 154 .Fn au_to_sock_inet128 "struct sockaddr_in6 *so"
 155 .Ft "token_t *"
 156 .Fn au_to_sock_int "struct sockaddr_in *so"
 157 .Ft "token_t *"
 158 .Fn au_to_socket_ex "u_short so_domain" "u_short so_type" "struct sockaddr *sa_local" "struct sockaddr *sa_remote"
 159 .Ft "token_t *"
 160 .Fo au_to_subject32
 161 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 162 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 163 .Fc
 164 .Ft "token_t *"
 165 .Fo au_to_subject64
 166 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 167 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 168 .Fc
 169 .Ft "token_t *"
 170 .Fo au_to_subject
 171 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 172 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 173 .Fc
 174 .Ft "token_t *"
 175 .Fo au_to_subject32_ex
 176 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 177 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 178 .Fc
 179 .Ft "token_t *"
 180 .Fo au_to_subject64_ex
 181 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 182 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 183 .Fc
 184 .Ft "token_t *"
 185 .Fo au_to_subject_ex
 186 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 187 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 188 .Fc
 189 .Ft "token_t *"
 190 .Fn au_to_me void
 191 .Ft "token_t *"
 192 .Fn au_to_exec_args "char **argv"
 193 .Ft "token_t *"
 194 .Fn au_to_exec_env "char **envp"
 195 .Ft "token_t *"
 196 .Fn au_to_header "int rec_size" "au_event_t e_type" "au_emod_t emod"
 197 .Ft "token_t *"
 198 .Fn au_to_header32 "int rec_size" "au_event_t e_type" "au_emod_t emod"
 199 .Ft "token_t *"
 200 .Fn au_to_header64 "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 201 .Ft "token_t *"
 202 .Fn au_to_header_ex "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 203 .Ft "token_t *"
 204 .Fn au_to_header32_ex "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 205 .Ft "token_t *"
 206 .Fn au_to_trailer "int rec_size"
 207 .Ft "token_t *"
 208 .Fn au_to_zonename "const char *zonename"
 209 .Sh DESCRIPTION
 210 These interfaces support the allocation of BSM audit tokens, represented by
 211 .Vt token_t ,
 212 for various data types.
 213 .Pp
 214 .Xr au_errno_to_bsm 3
 215 must be used to convert local
 216 .Xr errno 2
 217 errors to BSM error numbers before they are passed to
 218 .Fn au_to_return ,
 219 .Fn au_to_return32 ,
 220 and
 221 .Fn au_to_return64 .
 222 .Sh RETURN VALUES
 223 On success, a pointer to a
 224 .Vt token_t
 225 will be returned; the allocated
 226 .Vt token_t
 227 can be freed via a call to
 228 .Xr au_free_token 3 .
 229 On failure,
 230 .Dv NULL
 231 will be returned, and an error condition returned via
 232 .Va errno .
 233 .Sh SEE ALSO
 234 .Xr au_errno_to_bsm 3 ,
 235 .Xr libbsm 3
 236 .Sh HISTORY
 237 The OpenBSM implementation was created by McAfee Research, the security
 238 division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
 239 It was subsequently adopted by the TrustedBSD Project as the foundation for
 240 the OpenBSM distribution.
 241 .Sh AUTHORS
 242 .An -nosplit
 243 This software was created by
 244 .An Robert Watson ,
 245 .An Wayne Salamon ,
 246 and
 247 .An Suresh Krishnaswamy
 248 for McAfee Research, the security research division of McAfee,
 249 Inc., under contract to Apple Computer, Inc.
 250 .Pp
 251 The Basic Security Module (BSM) interface to audit records and audit event
 252 stream format were defined by Sun Microsystems.