sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-01-10 01:18:15 +03:00
Code

auth/gensec: add some basic doxygen comments for gensec_{want,have}_feature()

Browse Source 
Signed-off-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
This commit is contained in:
Stefan Metzmacher 2017-05-14 02:06:08 +02:00 committed by Andrew Bartlett
parent 8ddf3166d4
commit 39b0ba4f96
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
auth/gensec/gensec.h
View File

@ -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);