File: sasl_usererr.rst.txt

package info (click to toggle)
cyrus-sasl2 2.1.27%2Bdfsg-2.1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,940 kB
  • sloc: ansic: 58,942; javascript: 8,745; sh: 4,843; java: 1,614; xml: 1,498; makefile: 1,265; python: 342; perl: 199
file content (42 lines) | stat: -rw-r--r-- 1,117 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.. saslman:: sasl_usererr(3)

.. _sasl-reference-manpages-library-sasl_usererr:


===============================================================================
**sasl_usererr** - Remove information leak about accounts from sasl error codes
===============================================================================

Synopsis
========

.. code-block:: C

    #include <sasl/sasl.h>

    static int sasl_usererr(int saslerr)

Description
===========

.. c:function::  int sasl_usererr(int saslerr)

    **sasl_usererr** is called to hide any potential data leaks to a client,
    by preventing a client from discovering if a username exists or if
    a user exists but the password is wrong.

    :param saslerr: specifies the error number to convert.

    This function should be called before calling :saslman:`sasl_errstring(3)`
    or :saslman:`sasl_errdetail(3)` if information is being passed to a client.

Return Value
============

Returns a client-safe error code.

See Also
========

:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_errdetail(3)`,
:saslman:`sasl_errors(3)`, :saslman:`sasl_errstring(3)`