lib/libgssapi/gss_import_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 .\" 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_IMPORT_NAME 3 PRM
  59 .Sh NAME
  60 .Nm gss_import_name
  61 .Nd Convert a contiguous string name to internal-form
  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_import_name
  68 .Fa "OM_uint32 *minor_status"
  69 .Fa "const gss_buffer_t input_name_buffer"
  70 .Fa "const gss_OID input_name_type"
  71 .Fa "gss_name_t *output_name"
  72 .Fc
  73 .Sh DESCRIPTION
  74 Convert a contiguous string name to internal form.
  75 In general,
  76 the internal name returned (via the
  77 .Fa output_name
  78 parameter) will not be an MN;
  79 the exception to this is if the
  80 .Fa input_name_type
  81 indicates that the contiguous string provided via the
  82 .Fa input_name_buffer
  83 parameter is of type
  84 .Dv GSS_C_NT_EXPORT_NAME ,
  85 in which case the returned internal name will be an MN for the
  86 mechanism that exported the name.
  87 .Sh PARAMETERS
  88 .Bl -tag
  89 .It minor_status
  90 Mechanism specific status code.
  91 .It input_name_buffer
  92 Buffer containing contiguous string name to convert.
  93 .It input_name_type
  94 Object ID specifying type of printable name.
  95 Applications may specify either
  96 .Dv GSS_C_NO_OID
  97 to use a mechanism-specific default printable syntax,
  98 or an OID recognized by the GSS-API implementation to name a specific
  99 namespace.
 100 .It output_name
 101 Returned name in internal form.
 102 Storage associated with this name must be freed by the application
 103 after use with a call to
 104 .Fn gss_release_name .
 105 .El
 106 .Sh RETURN VALUES
 107 .Bl -tag
 108 .It GSS_S_COMPLETE
 109 Successful completion
 110 .It GSS_S_BAD_NAMETYPE
 111 The
 112 .Fa input_name_type
 113 was unrecognized
 114 .It GSS_S_BAD_NAME
 115 The
 116 .Fa input_name
 117 parameter could not be interpreted as a name of the specified type
 118 .It GSS_S_BAD_MECH
 119 The input name-type was
 120 .Dv GSS_C_NT_EXPORT_NAME ,
 121 but the mechanism contained within the input-name is not supported
 122 .El
 123 .Sh SEE ALSO
 124 .Xr gss_release_name 3
 125 .Sh STANDARDS
 126 .Bl -tag
 127 .It RFC 2743
 128 Generic Security Service Application Program Interface Version 2, Update 1
 129 .It RFC 2744
 130 Generic Security Service API Version 2 : C-bindings
 131 .\" .Sh HISTORY
 132 .El
 133 .Sh HISTORY
 134 The
 135 .Nm
 136 manual page example first appeared in
 137 .Fx 7.0 .
 138 .Sh AUTHORS
 139 John Wray, Iris Associates