1.. saslman:: sasl_verifyfile_t(3)
2
3.. _sasl-reference-manpages-library-sasl_verifyfile_t:
4
5
6==================================================
7**sasl_verifyfile_t** - The SASL file verification
8==================================================
9
10Synopsis
11========
12
13.. code-block:: C
14
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_type_t
23
24    int sasl_verifyfile_t(void *context,
25                    const char *file,
26                    sasl_verify_type_t type)
27
28
29Description
30===========
31
32.. c:function::    int sasl_verifyfile_t(void *context,
33        const char *file,
34        sasl_verify_type_t type)
35
36    **sasl_verifyfile_t()** is used to check whether a given file is
37    okay for use by the SASL library.   This  is  intended  to
38    allow  applications  to  sanity  check  the environment. For example, to
39    ensure that plugins or the config file cannot  be  written
40    to.
41
42    :param context: context from the callback record
43
44    :param context: context from the callback record
45
46    :param file: full path of the file to verify
47
48    :param type: type of the file.
49
50
51Return Value
52============
53
54SASL  callback  functions should return SASL return codes.
55See sasl.h for a complete list. :c:macro:`SASL_OK` indicates success.
56
57Other return codes indicate errors and should be handled.
58
59See Also
60========
61
62:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`
63:saslman:`sasl_errors(3)`
64