lib/libgssapi/gss_inquire_cred.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd January 26, 2010
  31 .Dt GSS_INQUIRE_CRED 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_inquire_cred
  35 .Nd Obtain information about a credential
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_inquire_cred
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_cred_id_t cred_handle"
  44 .Fa "gss_ctx_id_t *context_handle"
  45 .Fa "gss_name_t *name"
  46 .Fa "OM_uint32 *lifetime"
  47 .Fa "gss_cred_usage_t *cred_usage"
  48 .Fa "gss_OID_set *mechanisms"
  49 .Fc
  50 .Sh DESCRIPTION
  51 Obtains information about a credential.
  52 .Sh PARAMETERS
  53 .Bl -tag -width ".It minor_status"
  54 .It minor_status
  55 Mechanism specific status code.
  56 .It cred_handle
  57 A handle that refers to the target credential.
  58 Specify
  59 .Dv GSS_C_NO_CREDENTIAL
  60 to inquire about the default initiator principal.
  61 .It name
  62 The name whose identity the credential asserts.
  63 Storage associated with this name should be freed by the application
  64 after use with a call to
  65 .Fn gss_release_name .
  66 Specify
  67 .Dv NULL
  68 if not required.
  69 .It lifetime
  70 The number of seconds for which the credential will remain valid.
  71 If the credential has expired,
  72 this parameter will be set to zero.
  73 If the implementation does not support credential expiration,
  74 the value GSS_C_INDEFINITE will be returned.
  75 Specify
  76 .Dv NULL
  77 if not required.
  78 .It cred_usage
  79 How the credential may be used.
  80 One of the following:
  81 .Bl -item -offset indent -compact
  82 .It
  83 .Dv GSS_C_INITIATE
  84 .It
  85 .Dv GSS_C_ACCEPT
  86 .It
  87 .Dv GSS_C_BOTH
  88 .El
  89 Specify
  90 .Dv NULL
  91 if not required.
  92 .It mechanisms
  93 Set of mechanisms supported by the credential.
  94 Storage associated with this OID set must be freed by the application
  95 after use with a call to
  96 .Fn gss_release_oid_set .
  97 Specify
  98 .Dv NULL
  99 if not required.
 100 .El
 101 .Sh RETURN VALUES
 102 .Bl -tag -width ".It GSS_S_DEFECTIVE_CREDENTIAL"
 103 .It GSS_S_COMPLETE
 104 Successful completion
 105 .It GSS_S_NO_CRED
 106 The referenced credentials could not be accessed
 107 .It GSS_S_DEFECTIVE_CREDENTIAL
 108 The referenced credentials were invalid
 109 .It GSS_S_CREDENTIALS_EXPIRED
 110 The referenced credentials have expired.
 111 If the lifetime parameter was not passed as
 112 .Dv NULL ,
 113 it will be set to 0
 114 .El
 115 .Sh SEE ALSO
 116 .Xr gss_release_name 3 ,
 117 .Xr gss_release_oid_set 3
 118 .Sh STANDARDS
 119 .Bl -tag -width ".It RFC 2743"
 120 .It RFC 2743
 121 Generic Security Service Application Program Interface Version 2, Update 1
 122 .It RFC 2744
 123 Generic Security Service API Version 2 : C-bindings
 124 .El
 125 .Sh HISTORY
 126 The
 127 .Nm
 128 function first appeared in
 129 .Fx 7.0 .
 130 .Sh AUTHORS
 131 John Wray, Iris Associates
 132 .Sh COPYRIGHT
 133 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 134 .Pp
 135 This document and translations of it may be copied and furnished to
 136 others, and derivative works that comment on or otherwise explain it
 137 or assist in its implementation may be prepared, copied, published
 138 and distributed, in whole or in part, without restriction of any
 139 kind, provided that the above copyright notice and this paragraph are
 140 included on all such copies and derivative works.  However, this
 141 document itself may not be modified in any way, such as by removing
 142 the copyright notice or references to the Internet Society or other
 143 Internet organizations, except as needed for the purpose of
 144 developing Internet standards in which case the procedures for
 145 copyrights defined in the Internet Standards process must be
 146 followed, or as required to translate it into languages other than
 147 English.
 148 .Pp
 149 The limited permissions granted above are perpetual and will not be
 150 revoked by the Internet Society or its successors or assigns.
 151 .Pp
 152 This document and the information contained herein is provided on an
 153 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 154 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 155 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 156 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 157 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.