lib/libgssapi/gss_add_oid_set_member.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 .\" Copyright (C) The Internet Society (2000).  All Rights Reserved.
  30 .\"
  31 .\" This document and translations of it may be copied and furnished to
  32 .\" others, and derivative works that comment on or otherwise explain it
  33 .\" or assist in its implementation may be prepared, copied, published
  34 .\" and distributed, in whole or in part, without restriction of any
  35 .\" kind, provided that the above copyright notice and this paragraph are
  36 .\" included on all such copies and derivative works.  However, this
  37 .\" document itself may not be modified in any way, such as by removing
  38 .\" the copyright notice or references to the Internet Society or other
  39 .\" Internet organizations, except as needed for the purpose of
  40 .\" developing Internet standards in which case the procedures for
  41 .\" copyrights defined in the Internet Standards process must be
  42 .\" followed, or as required to translate it into languages other than
  43 .\" English.
  44 .\"
  45 .\" The limited permissions granted above are perpetual and will not be
  46 .\" revoked by the Internet Society or its successors or assigns.
  47 .\"
  48 .\" This document and the information contained herein is provided on an
  49 .\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  50 .\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  51 .\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  52 .\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  53 .\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  54 .\"
  55 .\" The following commands are required for all man pages.
  56 .Dd November 12, 2005
  57 .Os
  58 .Dt GSS_ADD_OID_SET_MEMBER 3 PRM
  59 .Sh NAME
  60 .Nm gss_add_oid_set_member
  61 .Nd Add an object identifier to a set
  62 .\" This next command is for sections 2 and 3 only.
  63 .\" .Sh LIBRARY
  64 .Sh SYNOPSIS
  65 .In "gssapi/gssapi.h"
  66 .Ft OM_uint32
  67 .Fo gss_add_oid_set_member
  68 .Fa "OM_uint32 *minor_status"
  69 .Fa "const gss_OID member_oid"
  70 .Fa "gss_OID_set *oid_set"
  71 .Fc
  72 .Sh DESCRIPTION
  73 Add an Object Identifier to an Object Identifier set.
  74 This routine is intended for use in conjunction with
  75 .Fn gss_create_empty_oid_set
  76 when constructing a set of mechanism OIDs for input to
  77 .Fn gss_acquire_cred .
  78 The
  79 .Fa oid_set
  80 parameter must refer to an OID-set that was created by GSS-API
  81 (e.g. a set returned by
  82 .Fn gss_create_empty_oid_set ).
  83 GSS-API creates a copy of the
  84 .Fa member_oid
  85 and inserts this copy into the set,
  86 expanding the storage allocated to the OID-set's elements array if
  87 necessary.
  88 The routine may add the new member OID anywhere within the elements
  89 array,
  90 and implementations should verify that the new
  91 .Fa member_oid
  92 is not already contained within the elements array;
  93 if the
  94 .Fa member_oid
  95 is already present,
  96 the
  97 .Fa oid_set
  98 should remain unchanged.
  99 .Sh PARAMETERS
 100 .Bl -tag
 101 .It minor_status
 102 Mechanism specific status code.
 103 .It member_oid
 104 The object identifier to copied into the set.
 105 .It oid_set
 106 The set in which the object identifier should be inserted.
 107 .El
 108 .Sh RETURN VALUES
 109 .Bl -tag
 110 .It GSS_S_COMPLETE
 111 Successful completion
 112 .El
 113 .Sh SEE ALSO
 114 .Xr gss_create_empty_oid_set 3 ,
 115 .Xr gss_acquire_cred 3
 116 .Sh STANDARDS
 117 .Bl -tag
 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 .\" .Sh HISTORY
 123 .El
 124 .Sh HISTORY
 125 The
 126 .Nm
 127 manual page example first appeared in
 128 .Fx 7.0 .
 129 .Sh AUTHORS
 130 John Wray, Iris Associates