xref: /freebsd/crypto/krb5/doc/html/_sources/appdev/refs/api/krb5_set_password.rst.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1krb5_set_password -  Set a password for a principal using specified credentials.
2=================================================================================
3
4..
5
6.. c:function:: krb5_error_code krb5_set_password(krb5_context context, krb5_creds * creds, const char * newpw, krb5_principal change_password_for, int * result_code, krb5_data * result_code_string, krb5_data * result_string)
7
8..
9
10
11:param:
12
13	          **[in]** **context** - Library context
14
15	          **[in]** **creds** - Credentials for kadmin/changepw service
16
17	          **[in]** **newpw** - New password
18
19	          **[in]** **change_password_for** - Change the password for this principal
20
21	          **[out]** **result_code** - Numeric error code from server
22
23	          **[out]** **result_code_string** - String equivalent to *result_code*
24
25	          **[out]** **result_string** - Data returned from the remote system
26
27
28..
29
30
31:retval:
32         -   0   Success and result_code is set to #KRB5_KPASSWD_SUCCESS.
33
34
35:return:
36         -  Kerberos error codes.
37
38..
39
40
41
42
43
44
45
46This function uses the credentials *creds* to set the password *newpw* for the principal *change_password_for* . It implements the set password operation of RFC 3244, for interoperability with Microsoft Windows implementations.
47
48
49
50The error code and strings are returned in *result_code* , *result_code_string* and *result_string* .
51
52
53
54
55
56
57
58
59
60
61..
62
63
64
65
66
67
68.. note::
69
70	 If *change_password_for* is NULL, the change is performed on the current principal. If *change_password_for* is non-null, the change is performed on the principal name passed in *change_password_for* .
71
72
73
74
75