xref: /freebsd-src/lib/libgssapi/gss_compare_name.3 (revision 17ed18fef3ee30b72f8f88ef7b43d082ae8d8bf1)
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_COMPARE_NAME PRM
59.Sh NAME
60.Nm gss_compare_name
61.Nd Compare two internal-form names
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_compare_name
68.Fa "OM_uint32 *minor_status"
69.Fa "const gss_name_t name1"
70.Fa "const gss_name_t name2"
71.Fa "int *name_equal"
72.Fc
73.Sh DESCRIPTION
74Allows an application to compare two internal-form names to determine
75whether they refer to the same entity.
76.Pp
77If either name presented to
78.Fn gss_compare_name
79denotes an anonymous principal,
80the routines should indicate that the two names do not refer to the
81same identity.
82.Sh PARAMETERS
83.Bl -tag
84.It minor_status
85Mechanism specific status code.
86.It name1
87Internal-form name.
88.It name2
89Internal-form name.
90.It name_equal
91.Bl -tag
92.It non-zero
93Names refer to same entity
94.It zero
95Names refer to different entities (strictly, the names are not known
96to refer to the same identity).
97.El
98.El
99.Sh RETURN VALUES
100.Bl -tag
101.It GSS_S_COMPLETE
102Successful completion
103.It GSS_S_BAD_NAMETYPE
104The two names were of incomparable types.
105.It GSS_S_BAD_NAME
106One or both of name1 or name2 was ill-formed.
107.El
108.Sh STANDARDS
109.Bl -tag
110.It RFC 2743
111Generic Security Service Application Program Interface Version 2, Update 1
112.It RFC 2744
113Generic Security Service API Version 2 : C-bindings
114.\" .Sh HISTORY
115.El
116.Sh HISTORY
117The
118.Nm
119manual page example first appeared in
120.Fx 7.0 .
121.Sh AUTHORS
122John Wray, Iris Associates
123