lib/libgssapi/gss_compare_name.3

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