From 321c295fda927322ce07d78f974d72e0876d86e5 Mon Sep 17 00:00:00 2001 From: Theodore Tso Date: Mon, 21 Nov 1994 19:25:57 +0000 Subject: [PATCH] library.tex (internalfunc): Define \internalfunc, which prints a disclaimer in front of "internal functions". We should move them somewhere else, but for now, let's start marking those functions which we believe are internal. krb5.tex: Documented changed interfaces to krb5_encode_kdc_rep and krb5_encrypt_tkt_part. Document krb5_encode_kdc_rep, krb5_decode_kdc_rep, krb5_encrypt_tkt_part, krb5_decrypt_tkt_part, and krb5_send_tgs as all internal functions. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@4708 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/api/ChangeLog | 13 +++++++++++++ doc/api/krb5.tex | 22 +++++++++++++++++----- doc/api/library.tex | 4 ++++ 3 files changed, 34 insertions(+), 5 deletions(-) diff --git a/doc/api/ChangeLog b/doc/api/ChangeLog index 4548ba0c0..e03cd0bb4 100644 --- a/doc/api/ChangeLog +++ b/doc/api/ChangeLog @@ -1,3 +1,16 @@ +Mon Nov 21 14:17:50 1994 Theodore Y. Ts'o (tytso@dcl) + + * library.tex (internalfunc): Define \internalfunc, which prints a + disclaimer in front of "internal functions". We should + move them somewhere else, but for now, let's start marking + those functions which we believe are internal. + + * krb5.tex: Documented changed interfaces to krb5_encode_kdc_rep + and krb5_encrypt_tkt_part. Document krb5_encode_kdc_rep, + krb5_decode_kdc_rep, krb5_encrypt_tkt_part, + krb5_decrypt_tkt_part, and krb5_send_tgs as all internal + functions. + Thu Oct 13 13:14:48 1994 Theodore Y. Ts'o (tytso@dcl) * krb5.tex: Fixed typo; extra space in \funcname{ krb5_recvauth}. diff --git a/doc/api/krb5.tex b/doc/api/krb5.tex index 23a4593fa..265f64e0b 100644 --- a/doc/api/krb5.tex +++ b/doc/api/krb5.tex @@ -4,6 +4,7 @@ tickets, creating authenticators, and the like. \begin{funcdecl}{krb5_encode_kdc_rep}{krb5_error_code}{\funcin} \funcarg{const krb5_msgtype}{type} \funcarg{const krb5_enc_kdc_rep_part *}{encpart} +\funcarg{krb5_encrypt_block *}{eblock} \funcarg{const krb5_keyblock *}{client_key} \funcinout \funcarg{krb5_kdc_rep *}{dec_rep} @@ -11,10 +12,12 @@ tickets, creating authenticators, and the like. \funcarg{krb5_data **}{enc_rep} \end{funcdecl} +\internalfunc + Takes KDC rep parts in \funcparam{*rep} and \funcparam{*encpart}, and -formats it into \funcparam{*enc_rep}, using message type \funcparam{type} -and encryption key \funcparam{client_key} and encryption type -\funcparam{dec_rep{\ptsto}etype}. +formats it into \funcparam{*enc_rep}, using message type +\funcparam{type} and encryption key \funcparam{client_key} and +encryption block \funcparam{eblock}. \funcparam{enc_rep{\ptsto}data} will point to allocated storage upon non-error return; the caller should free it when finished. @@ -29,6 +32,8 @@ Returns system errors. \funcarg{krb5_kdc_rep **}{dec_rep} \end{funcdecl} +\internalfunc + Takes a KDC_REP message and decrypts encrypted part using \funcparam{etype} and \funcparam{*key}, putting result in \funcparam{*dec_rep}. The pointers in \funcparam{dec_rep} @@ -58,15 +63,18 @@ This function is suitable for use as the \funcparam{decrypt_proc} argument to \funcname{krb5_get_in_tkt}. \begin{funcdecl}{krb5_encrypt_tkt_part}{krb5_error_code}{ \funcin} +\funcarg{const krb5_encrypt_block *}{eblock} \funcarg{const krb5_keyblock *}{srv_key} \funcinout \funcarg{krb5_ticket *}{dec_ticket} \end{funcdecl} +\internalfunc + Takes unencrypted \funcparam{dec_ticket} and \funcparam{dec_ticket{\ptsto}enc_part2}, encrypts with -\funcparam{dec_ticket{\ptsto}etype} -using \funcparam{srv_key}, and places result in +the encryption system specified by \funcparam{eblock} using +\funcparam{srv_key}, and places result in \funcparam{dec_ticket{\ptsto}enc_part}. The string \funcparam{dec_ticket{\ptsto}enc_part} will be allocated before formatting. @@ -82,6 +90,8 @@ encrypted stuff. \funcarg{krb5_ticket *}{dec_ticket} \end{funcdecl} +\internalfunc + Takes encrypted \funcparam{dec_ticket{\ptsto}enc_part}, encrypts with \funcparam{dec_ticket{\ptsto}etype} using \funcparam{srv_key}, and places result in @@ -106,6 +116,8 @@ Returns errors from encryption routines, system errors \funcarg{krb5_response *}{rep} \end{funcdecl} +\internalfunc + Sends a request to the TGS and waits for a response. \funcparam{options} is used for the options in the KRB_TGS_REQ. \funcparam{timestruct} values are used for from, till, and rtime in the diff --git a/doc/api/library.tex b/doc/api/library.tex index 213ef0176..800b279a2 100644 --- a/doc/api/library.tex +++ b/doc/api/library.tex @@ -39,6 +39,10 @@ \cfoot{\thepage} \else\pagestyle{headings}\fi +\def\internalfunc{NOTE: This is an internal function, which is not +necessarily intended for use by application programs. Its interface may +change at any time.\par} + %nlg- time to make this a real document \title{\Huge Kerberos V5 application programming library} -- 2.26.2