lib/libgssapi/gss_release_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_RELEASE_CRED 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_release_cred
  35 .Nd Discard a credential handle
  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_release_cred
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "gss_cred_id_t *cred_handle"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Informs GSS-API that the specified credential handle is no longer
  47 required by the application,
  48 and frees associated resources.
  49 Implementations are encouraged to set the cred_handle to
  50 .Dv GSS_C_NO_CREDENTIAL
  51 on successful completion of this call.
  52 .Sh PARAMETERS
  53 .Bl -tag -width ".It minor_status"
  54 .It minor_status
  55 Mechanism specific status code.
  56 .It cred_handle
  57 Opaque handle identifying credential to be released.
  58 If GSS_C_NO_CREDENTIAL is supplied,
  59 the routine will complete successfully, but will do nothing.
  60 .El
  61 .Sh RETURN VALUES
  62 .Bl -tag -width ".It GSS_S_COMPLETE"
  63 .It GSS_S_COMPLETE
  64 Successful completion
  65 .It GSS_S_NO_CRED
  66 Credentials could not be accessed
  67 .El
  68 .Sh STANDARDS
  69 .Bl -tag -width ".It RFC 2743"
  70 .It RFC 2743
  71 Generic Security Service Application Program Interface Version 2, Update 1
  72 .It RFC 2744
  73 Generic Security Service API Version 2 : C-bindings
  74 .El
  75 .Sh HISTORY
  76 The
  77 .Nm
  78 function first appeared in
  79 .Fx 7.0 .
  80 .Sh AUTHORS
  81 John Wray, Iris Associates
  82 .Sh COPYRIGHT
  83 Copyright (C) The Internet Society (2000).  All Rights Reserved.
  84 .Pp
  85 This document and translations of it may be copied and furnished to
  86 others, and derivative works that comment on or otherwise explain it
  87 or assist in its implementation may be prepared, copied, published
  88 and distributed, in whole or in part, without restriction of any
  89 kind, provided that the above copyright notice and this paragraph are
  90 included on all such copies and derivative works.  However, this
  91 document itself may not be modified in any way, such as by removing
  92 the copyright notice or references to the Internet Society or other
  93 Internet organizations, except as needed for the purpose of
  94 developing Internet standards in which case the procedures for
  95 copyrights defined in the Internet Standards process must be
  96 followed, or as required to translate it into languages other than
  97 English.
  98 .Pp
  99 The limited permissions granted above are perpetual and will not be
 100 revoked by the Internet Society or its successors or assigns.
 101 .Pp
 102 This document and the information contained herein is provided on an
 103 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 104 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 105 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 106 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 107 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.