xref: /freebsd/lib/libgssapi/gss_create_empty_oid_set.3 (revision c0b9f4fe659b6839541970eb5675e57f4d814969)
1c0b9f4feSDoug Rabson.\" -*- nroff -*-
2c0b9f4feSDoug Rabson.\"
3c0b9f4feSDoug Rabson.\" Copyright (c) 2005 Doug Rabson
4c0b9f4feSDoug Rabson.\" All rights reserved.
5c0b9f4feSDoug Rabson.\"
6c0b9f4feSDoug Rabson.\" Redistribution and use in source and binary forms, with or without
7c0b9f4feSDoug Rabson.\" modification, are permitted provided that the following conditions
8c0b9f4feSDoug Rabson.\" are met:
9c0b9f4feSDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
10c0b9f4feSDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
11c0b9f4feSDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
12c0b9f4feSDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
13c0b9f4feSDoug Rabson.\"    documentation and/or other materials provided with the distribution.
14c0b9f4feSDoug Rabson.\"
15c0b9f4feSDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16c0b9f4feSDoug Rabson.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17c0b9f4feSDoug Rabson.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18c0b9f4feSDoug Rabson.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19c0b9f4feSDoug Rabson.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20c0b9f4feSDoug Rabson.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21c0b9f4feSDoug Rabson.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22c0b9f4feSDoug Rabson.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23c0b9f4feSDoug Rabson.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24c0b9f4feSDoug Rabson.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25c0b9f4feSDoug Rabson.\" SUCH DAMAGE.
26c0b9f4feSDoug Rabson.\"
27c0b9f4feSDoug Rabson.\"	$FreeBSD$
28c0b9f4feSDoug Rabson.\"
29c0b9f4feSDoug Rabson.\" Copyright (C) The Internet Society (2000).  All Rights Reserved.
30c0b9f4feSDoug Rabson.\"
31c0b9f4feSDoug Rabson.\" This document and translations of it may be copied and furnished to
32c0b9f4feSDoug Rabson.\" others, and derivative works that comment on or otherwise explain it
33c0b9f4feSDoug Rabson.\" or assist in its implementation may be prepared, copied, published
34c0b9f4feSDoug Rabson.\" and distributed, in whole or in part, without restriction of any
35c0b9f4feSDoug Rabson.\" kind, provided that the above copyright notice and this paragraph are
36c0b9f4feSDoug Rabson.\" included on all such copies and derivative works.  However, this
37c0b9f4feSDoug Rabson.\" document itself may not be modified in any way, such as by removing
38c0b9f4feSDoug Rabson.\" the copyright notice or references to the Internet Society or other
39c0b9f4feSDoug Rabson.\" Internet organizations, except as needed for the purpose of
40c0b9f4feSDoug Rabson.\" developing Internet standards in which case the procedures for
41c0b9f4feSDoug Rabson.\" copyrights defined in the Internet Standards process must be
42c0b9f4feSDoug Rabson.\" followed, or as required to translate it into languages other than
43c0b9f4feSDoug Rabson.\" English.
44c0b9f4feSDoug Rabson.\"
45c0b9f4feSDoug Rabson.\" The limited permissions granted above are perpetual and will not be
46c0b9f4feSDoug Rabson.\" revoked by the Internet Society or its successors or assigns.
47c0b9f4feSDoug Rabson.\"
48c0b9f4feSDoug Rabson.\" This document and the information contained herein is provided on an
49c0b9f4feSDoug Rabson.\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
50c0b9f4feSDoug Rabson.\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
51c0b9f4feSDoug Rabson.\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
52c0b9f4feSDoug Rabson.\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
53c0b9f4feSDoug Rabson.\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
54c0b9f4feSDoug Rabson.\"
55c0b9f4feSDoug Rabson.\" The following commands are required for all man pages.
56c0b9f4feSDoug Rabson.Dd November 12, 2005
57c0b9f4feSDoug Rabson.Os
58c0b9f4feSDoug Rabson.Dt GSS_CREATE_EMPTY_OID_SET 3 PRM
59c0b9f4feSDoug Rabson.Sh NAME
60c0b9f4feSDoug Rabson.Nm gss_create_empty_oid_set
61c0b9f4feSDoug Rabson.Nd Create a set containing no object identifiers
62c0b9f4feSDoug Rabson.\" This next command is for sections 2 and 3 only.
63c0b9f4feSDoug Rabson.\" .Sh LIBRARY
64c0b9f4feSDoug Rabson.Sh SYNOPSIS
65c0b9f4feSDoug Rabson.In "gssapi/gssapi.h"
66c0b9f4feSDoug Rabson.Ft OM_uint32
67c0b9f4feSDoug Rabson.Fo gss_create_empty_oid_set
68c0b9f4feSDoug Rabson.Fa "OM_uint32 *minor_status"
69c0b9f4feSDoug Rabson.Fa "gss_OID_set *oid_set"
70c0b9f4feSDoug Rabson.Fc
71c0b9f4feSDoug Rabson.Sh DESCRIPTION
72c0b9f4feSDoug RabsonCreate an object-identifier set containing no object identifiers,
73c0b9f4feSDoug Rabsonto which members may be subsequently added using the
74c0b9f4feSDoug Rabson.Fn gss_add_oid_set_member
75c0b9f4feSDoug Rabsonroutine.
76c0b9f4feSDoug RabsonThese routines are intended to be used to construct sets of mechanism
77c0b9f4feSDoug Rabsonobject identifiers for input to
78c0b9f4feSDoug Rabson.Fn gss_acquire_cred .
79c0b9f4feSDoug Rabson.Sh PARAMETERS
80c0b9f4feSDoug Rabson.Bl -tag
81c0b9f4feSDoug Rabson.It minor_status
82c0b9f4feSDoug RabsonMechanism specific status code.
83c0b9f4feSDoug Rabson.It oid_set
84c0b9f4feSDoug Rabson
85c0b9f4feSDoug RabsonThe empty object identifier set.
86c0b9f4feSDoug RabsonThe routine will allocate the gss_OID_set_desc object,
87c0b9f4feSDoug Rabsonwhich the application must free after use with a call to
88c0b9f4feSDoug Rabson.Fn gss_release_oid_set .
89c0b9f4feSDoug Rabson.El
90c0b9f4feSDoug Rabson.Sh RETURN VALUES
91c0b9f4feSDoug Rabson.Bl -tag
92c0b9f4feSDoug Rabson.It GSS_S_COMPLETE
93c0b9f4feSDoug RabsonSuccessful completion
94c0b9f4feSDoug Rabson.El
95c0b9f4feSDoug Rabson.Sh SEE ALSO
96c0b9f4feSDoug Rabson.Xr gss_add_oid_set_member 3 ,
97c0b9f4feSDoug Rabson.Xr gss_acquire_cred 3
98c0b9f4feSDoug Rabson.Sh STANDARDS
99c0b9f4feSDoug Rabson.Bl -tag
100c0b9f4feSDoug Rabson.It RFC 2743
101c0b9f4feSDoug RabsonGeneric Security Service Application Program Interface Version 2, Update 1
102c0b9f4feSDoug Rabson.It RFC 2744
103c0b9f4feSDoug RabsonGeneric Security Service API Version 2 : C-bindings
104c0b9f4feSDoug Rabson.\" .Sh HISTORY
105c0b9f4feSDoug Rabson.El
106c0b9f4feSDoug Rabson.Sh HISTORY
107c0b9f4feSDoug RabsonThe
108c0b9f4feSDoug Rabson.Nm
109c0b9f4feSDoug Rabsonmanual page example first appeared in
110c0b9f4feSDoug Rabson.Fx 7.0 .
111c0b9f4feSDoug Rabson.Sh AUTHORS
112c0b9f4feSDoug RabsonJohn Wray, Iris Associates
113