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