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