Commit manpage for krb5_set_password(3), based on Heimdal-20040606,

with small revisions by myself, reviewed/approved by Love.
This commit is contained in:
jonathan 2004-07-14 07:02:07 +00:00
parent 8da378abea
commit 98b92eb4a5
3 changed files with 118 additions and 2 deletions

View File

@ -0,0 +1,110 @@
.\" 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: krb5_set_password.3,v 1.1 2004/07/14 07:02:07 jonathan Exp $
.\"
.Dd June 2, 2004
.Dt KRB5_SET_PASSWORD 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_change_password ,
.Nm krb5_set_password ,
.Nm krb5_set_password_using_ccache
.Nd change password functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Ft krb5_error_code
.Fo krb5_change_password
.Fa "krb5_context context"
.Fa "krb5_creds *creds"
.Fa "char *newpw"
.Fa "int *result_code"
.Fa "krb5_data *result_code_string"
.Fa "krb5_data *result_string"
.Fc
.Ft krb5_error_code
.Fo krb5_set_password
.Fa "krb5_context context"
.Fa "krb5_creds *creds"
.Fa "char *newpw"
.Fa "krb5_principal targprinc",
.Fa "int *result_code"
.Fa "krb5_data *result_code_string"
.Fa "krb5_data *result_string"
.Fc
.Ft krb5_error_code
.Fo krb5_set_password_using_ccache
.Fa "krb5_context context"
.Fa "krb5_ccache ccache"
.Fa "char *newpw"
.Fa "krb5_principal targprinc"
.Fa "int *result_code"
.Fa "krb5_data *result_code_string"
.Fa "krb5_data *result_string"
.Fc
.Sh DESCRIPTION
These functions change the password for a given principal.
.Pp
.Fn krb5_set_password
and
.Fn krb5_set_password_using_ccache
are the newer of the three functions, and use a newer version of the
protocol (and also fall back to the older set-password protocol if
the newer protocol 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_ccache 3 ,
.Xr krb5_init_context 3

View File

@ -1,4 +1,4 @@
# $NetBSD: mi,v 1.714 2004/07/13 15:42:03 seb Exp $
# $NetBSD: mi,v 1.715 2004/07/14 07:02:07 jonathan Exp $
./etc/mtree/set.comp comp-sys-root
./usr/bin/addr2line comp-debug-bin bfd
./usr/bin/ar comp-util-bin bfd
@ -3419,6 +3419,7 @@
./usr/share/man/cat3/krb5_cc_set_flags.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_cc_store_cred.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_ccache.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_change_passwd.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_checksum_is_collision_proof.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_checksum_is_keyed.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_checksumsize.0 comp-krb5-catman kerberos,.cat
@ -3511,6 +3512,7 @@
./usr/share/man/cat3/krb5_principal_get_realm.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_print_address.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_set_default_realm.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat/krb5_set_password.3 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_set_warn_dest.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_sname_to_principal.0 comp-krb5-catman kerberos,.cat
./usr/share/man/cat3/krb5_sock_to_principal.0 comp-krb5-catman kerberos,.cat
@ -7152,6 +7154,7 @@
./usr/share/man/man3/krb5_cc_set_flags.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_cc_store_cred.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_ccache.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_change_passwd.0 comp-krb5-catman kerberos,.man
./usr/share/man/man3/krb5_checksum_is_collision_proof.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_checksum_is_keyed.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_checksumsize.3 comp-krb5-man kerberos,.man
@ -7244,6 +7247,7 @@
./usr/share/man/man3/krb5_principal_get_realm.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_print_address.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_set_default_realm.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_set_password.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_set_warn_dest.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_sname_to_principal.3 comp-krb5-man kerberos,.man
./usr/share/man/man3/krb5_sock_to_principal.3 comp-krb5-man kerberos,.man

View File

@ -1,4 +1,4 @@
# $NetBSD: Makefile,v 1.28 2003/07/10 10:34:24 lukem Exp $
# $NetBSD: Makefile,v 1.29 2004/07/14 07:02:07 jonathan Exp $
NOLINT= # defined
@ -161,6 +161,7 @@ MAN= \
krb5_openlog.3 \
krb5_parse_name.3 \
krb5_principal_get_realm.3 \
krb5_set_password.3 \
krb5_set_default_realm.3 \
krb5_sname_to_principal.3 \
krb5_timeofday.3 \
@ -314,6 +315,7 @@ MLINKS= \
krb5_openlog.3 krb5_vlog.3 \
krb5_openlog.3 krb5_vlog_msg.3 \
krb5_principal_get_realm.3 krb5_principal_get_comp_string.3 \
krb5_set_password.3 krb5_change_password.3 \
krb5_set_default_realm.3 krb5_free_host_realm.3 \
krb5_set_default_realm.3 krb5_get_default_realm.3 \
krb5_set_default_realm.3 krb5_get_default_realms.3 \