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