document krb5_change_password and krb5_set_password
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@12262 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
82
lib/krb5/krb5_set_password.3
Normal file
82
lib/krb5/krb5_set_password.3
Normal file
@@ -0,0 +1,82 @@
|
||||
.\" Copyright (c) 2003 Kungliga Tekniska H<>gskolan
|
||||
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\"
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\"
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" 3. Neither the name of the Institute nor the names of its contributors
|
||||
.\" may be used to endorse or promote products derived from this software
|
||||
.\" without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $Id$
|
||||
.\"
|
||||
.Dd May 12, 2003
|
||||
.Dt KRB5_SET_PASSWORD 3
|
||||
.Os HEIMDAL
|
||||
.Sh NAME
|
||||
.Nm krb5_change_password ,
|
||||
.Nm krb5_set_password
|
||||
.Nd change password functions
|
||||
.Sh LIBRARY
|
||||
Kerberos 5 Library (libkrb5, -lkrb5)
|
||||
.Sh SYNOPSIS
|
||||
.In krb5.h
|
||||
.Ft krb5_error_code
|
||||
.Fn krb5_change_password "krb5_context context" "krb5_creds *creds" "char *newpw" "int *result_code" "krb5_data *result_code_string" "krb5_data *result_string"
|
||||
.Ft krb5_error_code
|
||||
.Fn krb5_set_password "krb5_context context" "krb5_ccache ccache" "char *newpw" "krb5_principal targprinc" "int *result_code" "krb5_data *result_code_string" "krb5_data *result_string"
|
||||
.Sh DESCRIPTION
|
||||
These functions change the password for a given principal.
|
||||
.Pp
|
||||
.Fn krb5_set_password
|
||||
is the newer of the two functions and uses a newer version of the
|
||||
protocol (and falls back to the older when the newer doesn't work).
|
||||
.Pp
|
||||
.Fn krb5_change_password
|
||||
set the password
|
||||
.Fa newpasswd
|
||||
for the client principal in
|
||||
.Fa creds .
|
||||
The server principal of creds must be
|
||||
.Li kadmin/changepw .
|
||||
.Pp
|
||||
.Fn krb5_set_password
|
||||
changes the password for the principal
|
||||
.Fa targprinc ,
|
||||
if
|
||||
.Fa targprinc
|
||||
is
|
||||
.Dv NULL
|
||||
the default principal in
|
||||
.Fa ccache
|
||||
is used.
|
||||
.Pp
|
||||
Both functions returns and error in
|
||||
.Fa result_code
|
||||
and maybe an error strings to print in
|
||||
.Fa result_string .
|
||||
.Sh SEE ALSO
|
||||
.Xr krb5_init_context 3 ,
|
||||
.Xr krb5_ccache 3
|
||||
|
Reference in New Issue
Block a user