lib/libgssapi/gss_inquire_cred_by_mech.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_BY_MECH 3 PRM
  30 .Os
  31 .Sh NAME
  32 .Nm gss_inquire_cred_by_mech
  33 .Nd Obtain per-mechanism 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_by_mech
  40 .Fa "OM_uint32 *minor_status"
  41 .Fa "const gss_cred_id_t cred_handle"
  42 .Fa "const gss_OID mech_type"
  43 .Fa "gss_name_t *name"
  44 .Fa "OM_uint32 *initiator_lifetime"
  45 .Fa "OM_uint32 *acceptor_lifetime"
  46 .Fa "gss_cred_usage_t *cred_usage"
  47 .Fc
  48 .Sh DESCRIPTION
  49 Obtains per-mechanism information about a credential.
  50 .Sh PARAMETERS
  51 .Bl -tag -width ".It initiator_lifetime"
  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 mech_type
  60 The mechanism for which information should be returned.
  61 .It name
  62 The name whose identity the credential asserts.
  63 Storage associated with this name must 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 initiator_lifetime
  70 The number of seconds for which the credential will remain capable of
  71 initiating security contexts under the specified mechanism.
  72 If the credential can no longer be used to initiate contexts,
  73 or if the credential usage for this mechanism is
  74 .Dv GSS_C_ACCEPT ,
  75 this parameter will be set to zero.
  76 If the implementation does not support expiration of initiator
  77 credentials,
  78 the value
  79 .Dv GSS_C_INDEFINITE
  80 will be returned.
  81 Specify
  82 .Dv NULL
  83 if not required.
  84 .It acceptor_lifetime
  85 The number of seconds for which the credential will remain capable of
  86 accepting security contexts under the specified mechanism.
  87 If the credential can no longer be used to accept contexts,
  88 or if the credential usage for this mechanism is
  89 .Dv GSS_C_INITIATE ,
  90 this parameter will be set to zero.
  91 If the implementation does not support expiration of acceptor
  92 credentials,
  93 the value
  94 .Dv GSS_C_INDEFINITE
  95 will be returned.
  96 Specify
  97 .Dv NULL
  98 if not required.
  99 .It cred_usage
 100 How the credential may be used with the specified mechanism.
 101 One of the following:
 102 .Bl -item -offset indent -compact
 103 .It
 104 .Dv GSS_C_INITIATE
 105 .It
 106 .Dv GSS_C_ACCEPT
 107 .It
 108 .Dv GSS_C_BOTH
 109 .El
 110 Specify
 111 .Dv NULL
 112 if not required.
 113 .El
 114 .Sh RETURN VALUES
 115 .Bl -tag -width ".It GSS_S_DEFECTIVE_CREDENTIAL"
 116 .It GSS_S_COMPLETE
 117 Successful completion
 118 .It GSS_S_NO_CRED
 119 The referenced credentials could not be accessed
 120 .It GSS_S_DEFECTIVE_CREDENTIAL
 121 The referenced credentials were invalid
 122 .It GSS_S_CREDENTIALS_EXPIRED
 123 The referenced credentials have expired.
 124 If the lifetime parameter was not passed as
 125 .Dv NULL ,
 126 it will be set to 0.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr gss_release_name 3
 130 .Sh STANDARDS
 131 .Bl -tag -width ".It RFC 2743"
 132 .It RFC 2743
 133 Generic Security Service Application Program Interface Version 2, Update 1
 134 .It RFC 2744
 135 Generic Security Service API Version 2 : C-bindings
 136 .El
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 function first appeared in
 141 .Fx 7.0 .
 142 .Sh AUTHORS
 143 John Wray, Iris Associates
 144 .Sh COPYRIGHT
 145 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 146 .Pp
 147 This document and translations of it may be copied and furnished to
 148 others, and derivative works that comment on or otherwise explain it
 149 or assist in its implementation may be prepared, copied, published
 150 and distributed, in whole or in part, without restriction of any
 151 kind, provided that the above copyright notice and this paragraph are
 152 included on all such copies and derivative works.  However, this
 153 document itself may not be modified in any way, such as by removing
 154 the copyright notice or references to the Internet Society or other
 155 Internet organizations, except as needed for the purpose of
 156 developing Internet standards in which case the procedures for
 157 copyrights defined in the Internet Standards process must be
 158 followed, or as required to translate it into languages other than
 159 English.
 160 .Pp
 161 The limited permissions granted above are perpetual and will not be
 162 revoked by the Internet Society or its successors or assigns.
 163 .Pp
 164 This document and the information contained herein is provided on an
 165 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 166 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 167 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 168 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 169 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.