diff options
author | Stefan Metzmacher <metze@samba.org> | 2017-05-14 02:06:08 +0200 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2017-05-21 21:05:09 +0200 |
commit | 39b0ba4f9648fe4137e66869974ed560f633df8d (patch) | |
tree | 75336049422f93075e9f6c72df1fdfaaac1c9836 /auth | |
parent | 8ddf3166d488f36c53f80080f7f17c78831080bc (diff) | |
download | samba-39b0ba4f9648fe4137e66869974ed560f633df8d.tar.gz |
auth/gensec: add some basic doxygen comments for gensec_{want,have}_feature()
Signed-off-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'auth')
-rw-r--r-- | auth/gensec/gensec.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/auth/gensec/gensec.h b/auth/gensec/gensec.h index e7b9477bffc..9a2bd9626ce 100644 --- a/auth/gensec/gensec.h +++ b/auth/gensec/gensec.h @@ -147,8 +147,51 @@ struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx, struct gensec_security *gensec_security, const DATA_BLOB in); NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out); +/** + * @brief Ask for features for a following authentication + * + * Typically only one specific feature bit should be passed, + * but it also works to ask for more features. + * + * The features must be requested before starting the + * gensec_update*() loop. + * + * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER, + * it can also be requested once the gensec_update*() loop + * returned NT_STATUS_OK. + * + * The features should not be changed during the gensec_update*() + * loop. + * + * @param[in] gensec_security The context to be used + * + * @param[in] feature The requested feature[s]. + * + */ void gensec_want_feature(struct gensec_security *gensec_security, uint32_t feature); +/** + * @brief Ask for one feature after the finished authentication + * + * Because the return value is bool, the caller can only + * ask for one feature at a time. + * + * The features must be requested after the finished + * gensec_update*() loop. + * + * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER, + * it can also be requested before the gensec_update*() loop, + * as the return value only indicates if the backend supports + * dcerpc header signing, not if header signing will be used + * between client and server. It will be used only if the caller + * also used gensec_want_feature(GENSEC_FEATURE_SIGN_PKT_HEADER). + * + * @param[in] gensec_security The context to be used. + * + * @param[in] feature The requested feature. + * + * @return true if the feature is supported, false if not. + */ bool gensec_have_feature(struct gensec_security *gensec_security, uint32_t feature); NTTIME gensec_expire_time(struct gensec_security *gensec_security); |