xref: /freebsd/lib/libgssapi/gss_compare_name.3 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
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_COMPARE_NAME 3 PRM
30.Os
31.Sh NAME
32.Nm gss_compare_name
33.Nd Compare two internal-form names
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_compare_name
40.Fa "OM_uint32 *minor_status"
41.Fa "const gss_name_t name1"
42.Fa "const gss_name_t name2"
43.Fa "int *name_equal"
44.Fc
45.Sh DESCRIPTION
46Allows an application to compare two internal-form names to determine
47whether they refer to the same entity.
48.Pp
49If either name presented to
50.Fn gss_compare_name
51denotes an anonymous principal,
52the routines should indicate that the two names do not refer to the
53same identity.
54.Sh PARAMETERS
55.Bl -tag -width "minor_status"
56.It minor_status
57Mechanism specific status code.
58.It name1
59Internal-form name.
60.It name2
61Internal-form name.
62.It name_equal
63.Bl -tag -width "non-zero"
64.It non-zero
65Names refer to same entity
66.It zero
67Names refer to different entities (strictly, the names are not known
68to refer to the same identity).
69.El
70.El
71.Sh RETURN VALUES
72.Bl -tag -width ".It GSS_S_BAD_NAMETYPE"
73.It GSS_S_COMPLETE
74Successful completion
75.It GSS_S_BAD_NAMETYPE
76The two names were of incomparable types.
77.It GSS_S_BAD_NAME
78One or both of name1 or name2 was ill-formed.
79.El
80.Sh STANDARDS
81.Bl -tag -width ".It RFC 2743"
82.It RFC 2743
83Generic Security Service Application Program Interface Version 2, Update 1
84.It RFC 2744
85Generic Security Service API Version 2 : C-bindings
86.El
87.Sh HISTORY
88The
89.Nm
90function first appeared in
91.Fx 7.0 .
92.Sh AUTHORS
93John Wray, Iris Associates
94.Sh COPYRIGHT
95Copyright (C) The Internet Society (2000).  All Rights Reserved.
96.Pp
97This document and translations of it may be copied and furnished to
98others, and derivative works that comment on or otherwise explain it
99or assist in its implementation may be prepared, copied, published
100and distributed, in whole or in part, without restriction of any
101kind, provided that the above copyright notice and this paragraph are
102included on all such copies and derivative works.  However, this
103document itself may not be modified in any way, such as by removing
104the copyright notice or references to the Internet Society or other
105Internet organizations, except as needed for the purpose of
106developing Internet standards in which case the procedures for
107copyrights defined in the Internet Standards process must be
108followed, or as required to translate it into languages other than
109English.
110.Pp
111The limited permissions granted above are perpetual and will not be
112revoked by the Internet Society or its successors or assigns.
113.Pp
114This document and the information contained herein is provided on an
115"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
116TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
117BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
118HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
119MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
120