summaryrefslogtreecommitdiffstats
path: root/doc/api
diff options
context:
space:
mode:
authorTheodore Tso <tytso@mit.edu>1990-12-11 13:29:14 +0000
committerTheodore Tso <tytso@mit.edu>1990-12-11 13:29:14 +0000
commite842aa405c6835ee58024b2786d60d43b4387794 (patch)
treedfee66841142162b33d7d22659b541baa5287929 /doc/api
parentc7fd1347eb07c225034a305c8cb4d87b1aaa6126 (diff)
downloadkrb5-e842aa405c6835ee58024b2786d60d43b4387794.tar.gz
krb5-e842aa405c6835ee58024b2786d60d43b4387794.tar.xz
krb5-e842aa405c6835ee58024b2786d60d43b4387794.zip
Documented extra argument to mk_req_extended
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@1534 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/krb5.tex9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/api/krb5.tex b/doc/api/krb5.tex
index b341660b9c..35a83b7b91 100644
--- a/doc/api/krb5.tex
+++ b/doc/api/krb5.tex
@@ -342,6 +342,7 @@ Returns system errors.
\funcarg{krb5_ccache}{ccache}
\funcinout
\funcarg{krb5_creds *}{creds}
+\funcarg{krb5_authenticator *}{authentp}
\funcout
\funcarg{krb5_data *}{outbuf}
\end{funcdecl}
@@ -370,7 +371,13 @@ If \funcparam{ap_req_options} specifies AP_OPTS_USE_SESSION_KEY, then
\funcparam{creds{\ptsto}ticket} must contain the appropriate
ENC-TKT-IN-SKEY ticket.
-\funcparam{checksum} specifies the checksum to be used in the authenticator.
+\funcparam{checksum} specifies the checksum to be used in the
+authenticator.
+
+If \funcparam{authentp} is non-NULL, it krb5_mk_req_extended will store
+a copy of authenticator there, with the principal and checksum fields
+nulled out. (This is to prevent pointer sharing problems; the caller
+shouldn't need these fields anyway, since the caller supplied them.)
The \funcparam{outbuf} buffer storage is allocated, and should be freed
by the caller when finished.