xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_read_password.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_read_password -  Read a password from keyboard input.
2===========================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_read_password(krb5_context context, const char * prompt, const char * prompt2, char * return_pwd, unsigned int * size_return)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **prompt** - First user prompt when reading password
16
17	          **[in]** **prompt2** - Second user prompt (NULL to prompt only once)
18
19	          **[out]** **return_pwd** - Returned password
20
21	          **[inout]** **size_return** - On input, maximum size of password; on output, size of password read
22
23
24..
25
26
27:retval:
28         -   0   Success
29
30
31:return:
32         -  Error in reading or verifying the password
33         -  Kerberos error codes
34
35..
36
37
38
39
40
41
42
43This function reads a password from keyboard input and stores it in *return_pwd* . *size_return* should be set by the caller to the amount of storage space available in *return_pwd* ; on successful return, it will be set to the length of the password read.
44
45
46
47 *prompt* is printed to the terminal, followed by":", and then a password is read from the keyboard.
48
49
50
51If *prompt2* is NULL, the password is read only once. Otherwise, *prompt2* is printed to the terminal and a second password is read. If the two passwords entered are not identical, KRB5_LIBOS_BADPWDMATCH is returned.
52
53
54
55Echoing is turned off when the password is read.
56
57
58
59
60
61
62
63
64
65
66..
67
68
69
70
71
72