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 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_token.3#17 $
  27 .\"
  28 .Dd April 19, 2005
  29 .Dt AU_TOKEN 3
  30 .Os
  31 .Sh NAME
  32 .Nm au_to_arg32 ,
  33 .Nm au_to_arg64 ,
  34 .Nm au_to_arg ,
  35 .Nm au_to_attr64 ,
  36 .Nm au_to_data ,
  37 .Nm au_to_exit ,
  38 .Nm au_to_groups ,
  39 .Nm au_to_newgroups ,
  40 .Nm au_to_in_addr ,
  41 .Nm au_to_in_addr_ex ,
  42 .Nm au_to_ip ,
  43 .Nm au_to_ipc ,
  44 .Nm au_to_ipc_perm ,
  45 .Nm au_to_iport ,
  46 .Nm au_to_opaque ,
  47 .Nm au_to_file ,
  48 .Nm au_to_text ,
  49 .Nm au_to_path ,
  50 .Nm au_to_process32 ,
  51 .Nm au_to_process64 ,
  52 .Nm au_to_process ,
  53 .Nm au_to_process32_ex ,
  54 .Nm au_to_process64_ex ,
  55 .Nm au_to_process_ex ,
  56 .Nm au_to_return32 ,
  57 .Nm au_to_return64 ,
  58 .Nm au_to_return ,
  59 .Nm au_to_seq ,
  60 .Nm au_to_sock_inet32 ,
  61 .Nm au_to_sock_inet128 ,
  62 .Nm au_to_sock_inet ,
  63 .Nm au_to_socket_ex ,
  64 .Nm au_to_subject32 ,
  65 .Nm au_to_subject64 ,
  66 .Nm au_to_subject ,
  67 .Nm au_to_subject32_ex ,
  68 .Nm au_to_subject64_ex ,
  69 .Nm au_to_subject_ex ,
  70 .Nm au_to_me ,
  71 .Nm au_to_exec_args ,
  72 .Nm au_to_exec_env ,
  73 .Nm au_to_header ,
  74 .Nm au_to_header32 ,
  75 .Nm au_to_header64 ,
  76 .Nm au_to_header_ex ,
  77 .Nm au_to_header32_ex ,
  78 .Nm au_to_trailer ,
  79 .Nm au_to_zonename
  80 .Nd "routines for generating BSM audit tokens"
  81 .Sh LIBRARY
  82 .Lb libbsm
  83 .Sh SYNOPSIS
  84 .In bsm/libbsm.h
  85 .Ft "token_t *"
  86 .Fn au_to_arg32 "char n" "const char *text" "u_int32_t v"
  87 .Ft "token_t *"
  88 .Fn au_to_arg64 "char n" "const char *text" "u_int64_t v"
  89 .Ft "token_t *"
  90 .Fn au_to_arg "char n" "const char *text" "u_int32_t v"
  91 .Ft "token_t *"
  92 .Fn au_to_attr32 "struct vattr *attr"
  93 .Ft "token_t *"
  94 .Fn au_to_attr64 "struct vattr *attr"
  95 .Ft "token_t *"
  96 .Fn au_to_attr "struct vattr *attr"
  97 .Ft "token_t *"
  98 .Fn au_to_data "char unit_print" "char unit_type" "char unit_count" "const char *p"
  99 .Ft "token_t *"
 100 .Fn au_to_exit "int retval" "int err"
 101 .Ft "token_t *"
 102 .Fn au_to_groups "int *groups"
 103 .Ft "token_t *"
 104 .Fn au_to_newgroups "u_int16_t n" "gid_t *groups"
 105 .Ft "token_t *"
 106 .Fn au_to_in_addr "struct in_addr *internet_addr"
 107 .Ft "token_t *"
 108 .Fn au_to_in_addr_ex "struct in6_addr *internet_addr"
 109 .Ft "token_t *"
 110 .Fn au_to_ip "struct ip *ip"
 111 .Ft "token_t *"
 112 .Fn au_to_ipc "char type" "int id"
 113 .Ft "token_t *"
 114 .Fn au_to_ipc_perm "struct ipc_perm *perm"
 115 .Ft "token_t *"
 116 .Fn au_to_iport "u_int16_t iport"
 117 .Ft "token_t *"
 118 .Fn au_to_opaque "const char *data" "u_int16_t bytes"
 119 .Ft "token_t *"
 120 .Fn au_to_file "const char *file" "struct timeval tm"
 121 .Ft "token_t *"
 122 .Fn au_to_text "const char *text"
 123 .Ft "token_t *"
 124 .Fn au_to_path "const char *text"
 125 .Ft "token_t *"
 126 .Fo au_to_process32
 127 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 128 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 129 .Fc
 130 .Ft "token_t *"
 131 .Fo au_to_process64
 132 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 133 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 134 .Fc
 135 .Ft "token_t *"
 136 .Fo au_to_process32_ex
 137 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 138 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 139 .Fc
 140 .Ft "token_t *"
 141 .Fo au_to_process64_ex
 142 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 143 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 144 .Fc
 145 .Ft "token_t *"
 146 .Fn au_to_return32 "char status" "u_int32_t ret"
 147 .Ft "token_t *"
 148 .Fn au_to_return64 "char status" "u_int64_t ret"
 149 .Ft "token_t *"
 150 .Fn au_to_return "char status" "u_int32_t ret"
 151 .Ft "token_t *"
 152 .Fn au_to_seq "long audit_count"
 153 .Ft "token_t *"
 154 .Fn au_to_sock_inet32 "struct sockaddr_in *so"
 155 .Ft "token_t *"
 156 .Fn au_to_sock_inet128 "struct sockaddr_in6 *so"
 157 .Ft "token_t *"
 158 .Fn au_to_sock_int "struct sockaddr_in *so"
 159 .Ft "token_t *"
 160 .Fn au_to_socket_ex "u_short so_domain" "u_short so_type" "struct sockaddr *sa_local" "struct sockaddr *sa_remote"
 161 .Ft "token_t *"
 162 .Fo au_to_subject32
 163 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 164 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 165 .Fc
 166 .Ft "token_t *"
 167 .Fo au_to_subject64
 168 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 169 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 170 .Fc
 171 .Ft "token_t *"
 172 .Fo au_to_subject
 173 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 174 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_t *tid"
 175 .Fc
 176 .Ft "token_t *"
 177 .Fo au_to_subject32_ex
 178 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 179 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 180 .Fc
 181 .Ft "token_t *"
 182 .Fo au_to_subject64_ex
 183 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 184 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 185 .Fc
 186 .Ft "token_t *"
 187 .Fo au_to_subject_ex
 188 .Fa "au_id_t auid" "uid_t euid" "gid_t egid" "uid_t ruid"
 189 .Fa "gid_t rgid" "pid_t pid" "au_asid_t sid" "au_tid_addr_t *tid"
 190 .Fc
 191 .Ft "token_t *"
 192 .Fn au_to_me void
 193 .Ft "token_t *"
 194 .Fn au_to_exec_args "char **argv"
 195 .Ft "token_t *"
 196 .Fn au_to_exec_env "char **envp"
 197 .Ft "token_t *"
 198 .Fn au_to_header "int rec_size" "au_event_t e_type" "au_emod_t emod"
 199 .Ft "token_t *"
 200 .Fn au_to_header32 "int rec_size" "au_event_t e_type" "au_emod_t emod"
 201 .Ft "token_t *"
 202 .Fn au_to_header64 "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 203 .Ft "token_t *"
 204 .Fn au_to_header_ex "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 205 .Ft "token_t *"
 206 .Fn au_to_header32_ex "int rec_size" "au_event_t e_type" "au_emod_t e_mod"
 207 .Ft "token_t *"
 208 .Fn au_to_trailer "int rec_size"
 209 .Ft "token_t *"
 210 .Fn au_to_zonename "const char *zonename"
 211 .Sh DESCRIPTION
 212 These interfaces support the allocation of BSM audit tokens, represented by
 213 .Vt token_t ,
 214 for various data types.
 215 .Pp
 216 .Xr au_errno_to_bsm 3
 217 must be used to convert local
 218 .Xr errno 2
 219 errors to BSM error numbers before they are passed to
 220 .Fn au_to_return ,
 221 .Fn au_to_return32 ,
 222 and
 223 .Fn au_to_return64 .
 224 .Sh RETURN VALUES
 225 On success, a pointer to a
 226 .Vt token_t
 227 will be returned; the allocated
 228 .Vt token_t
 229 can be freed via a call to
 230 .Xr au_free_token 3 .
 231 On failure,
 232 .Dv NULL
 233 will be returned, and an error condition returned via
 234 .Va errno .
 235 .Sh SEE ALSO
 236 .Xr au_errno_to_bsm 3 ,
 237 .Xr libbsm 3
 238 .Sh HISTORY
 239 The OpenBSM implementation was created by McAfee Research, the security
 240 division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
 241 It was subsequently adopted by the TrustedBSD Project as the foundation for
 242 the OpenBSM distribution.
 243 .Sh AUTHORS
 244 .An -nosplit
 245 This software was created by
 246 .An Robert Watson ,
 247 .An Wayne Salamon ,
 248 and
 249 .An Suresh Krishnaswamy
 250 for McAfee Research, the security research division of McAfee,
 251 Inc., under contract to Apple Computer, Inc.
 252 .Pp
 253 The Basic Security Module (BSM) interface to audit records and audit event
 254 stream format were defined by Sun Microsystems.