usr/src/man/man3sasl/sasl_verifyfile_t.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_VERIFYFILE_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_verifyfile_t \- the SASL file verification callback function
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 typedef enum {
  18        SASL_VRFY_PLUGIN,       /* a DLL/shared library plugin */
  19        SASL_VRFY_CONF,         /* a configuration file */
  20        SASL_VRFY_PASSWD,       /* a password storage file */
  21        SASL_VRFY_OTHER         /* some other file type */
  22 } sasl_verify_tyep_t
  23
  24 \fBint\fR \fBsasl_verifyfile_t\fR(\fBvoid *\fR\fIcontext\fR, \fBconst char *\fR\fIfile\fR,
  25      \fBsasl_verifyfile_t\fR \fItype\fR);
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 Use the \fBsasl_verifyfile_t()\fR callback function check whether a given file
  32 can be used by the SASL library. Applications use \fBsasl_verifyfile_t()\fR to
  33 check the environment to ensure that plugins or configuration files cannot be
  34 written to.
  35 .SH PARAMETERS
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIcontext\fR\fR
  40 .ad
  41 .RS 11n
  42 The context from the callback record
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fIfile\fR\fR
  49 .ad
  50 .RS 11n
  51 The full path of the file to verify
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fItype\fR\fR
  58 .ad
  59 .RS 11n
  60 The type of the file
  61 .RE
  62
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 Like other SASL callback functions, \fBsasl_verifyfile_t()\fR returns an
  67 integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a
  68 complete list of SASL error codes.
  69 .SH ERRORS
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBSASL_OK\fR\fR
  74 .ad
  75 .RS 11n
  76 The call to \fBsasl_verifyfile_t()\fR was successful.
  77 .RE
  78
  79 .sp
  80 .LP
  81 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Evolving
  96 _
  97 MT-Level        MT-Safe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)