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 .\" The following commands are required for all man pages.
  28 .Dd January 26, 2010
  29 .Dt GSS_IMPORT_NAME 3 PRM
  30 .Os
  31 .Sh NAME
  32 .Nm gss_import_name
  33 .Nd Convert a contiguous string name to internal-form
  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_import_name
  40 .Fa "OM_uint32 *minor_status"
  41 .Fa "const gss_buffer_t input_name_buffer"
  42 .Fa "const gss_OID input_name_type"
  43 .Fa "gss_name_t *output_name"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Convert a contiguous string name to internal form.
  47 In general,
  48 the internal name returned (via the
  49 .Fa output_name
  50 parameter) will not be an MN;
  51 the exception to this is if the
  52 .Fa input_name_type
  53 indicates that the contiguous string provided via the
  54 .Fa input_name_buffer
  55 parameter is of type
  56 .Dv GSS_C_NT_EXPORT_NAME ,
  57 in which case the returned internal name will be an MN for the
  58 mechanism that exported the name.
  59 .Sh PARAMETERS
  60 .Bl -tag -width ".It input_name_buffer"
  61 .It minor_status
  62 Mechanism specific status code.
  63 .It input_name_buffer
  64 Buffer containing contiguous string name to convert.
  65 .It input_name_type
  66 Object ID specifying type of printable name.
  67 Applications may specify either
  68 .Dv GSS_C_NO_OID
  69 to use a mechanism-specific default printable syntax,
  70 or an OID recognized by the GSS-API implementation to name a specific
  71 namespace.
  72 .It output_name
  73 Returned name in internal form.
  74 Storage associated with this name must be freed by the application
  75 after use with a call to
  76 .Fn gss_release_name .
  77 .El
  78 .Sh RETURN VALUES
  79 .Bl -tag -width "It GSS_S_BAD_NAMETYPE"
  80 .It GSS_S_COMPLETE
  81 Successful completion
  82 .It GSS_S_BAD_NAMETYPE
  83 The
  84 .Fa input_name_type
  85 was unrecognized
  86 .It GSS_S_BAD_NAME
  87 The
  88 .Fa input_name
  89 parameter could not be interpreted as a name of the specified type
  90 .It GSS_S_BAD_MECH
  91 The input name-type was
  92 .Dv GSS_C_NT_EXPORT_NAME ,
  93 but the mechanism contained within the input-name is not supported
  94 .El
  95 .Sh SEE ALSO
  96 .Xr gss_release_name 3
  97 .Sh STANDARDS
  98 .Bl -tag -width ".It RFC 2743"
  99 .It RFC 2743
 100 Generic Security Service Application Program Interface Version 2, Update 1
 101 .It RFC 2744
 102 Generic Security Service API Version 2 : C-bindings
 103 .El
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 function first appeared in
 108 .Fx 7.0 .
 109 .Sh AUTHORS
 110 John Wray, Iris Associates
 111 .Sh COPYRIGHT
 112 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 113 .Pp
 114 This document and translations of it may be copied and furnished to
 115 others, and derivative works that comment on or otherwise explain it
 116 or assist in its implementation may be prepared, copied, published
 117 and distributed, in whole or in part, without restriction of any
 118 kind, provided that the above copyright notice and this paragraph are
 119 included on all such copies and derivative works.  However, this
 120 document itself may not be modified in any way, such as by removing
 121 the copyright notice or references to the Internet Society or other
 122 Internet organizations, except as needed for the purpose of
 123 developing Internet standards in which case the procedures for
 124 copyrights defined in the Internet Standards process must be
 125 followed, or as required to translate it into languages other than
 126 English.
 127 .Pp
 128 The limited permissions granted above are perpetual and will not be
 129 revoked by the Internet Society or its successors or assigns.
 130 .Pp
 131 This document and the information contained herein is provided on an
 132 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 133 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 134 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 135 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 136 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.