summaryrefslogtreecommitdiff
path: root/source4/libcli/auth/gensec.c
diff options
context:
space:
mode:
authorAndrew Bartlett <abartlet@samba.org>2005-01-05 03:21:45 +0000
committerGerald (Jerry) Carter <jerry@samba.org>2007-10-10 13:08:18 -0500
commit5e9a136908fdc2955f8554fee83fff4c93ec998a (patch)
treed5d9c65a68494f064ca1596532c736e43fc1faee /source4/libcli/auth/gensec.c
parent58d9adf409ac11c5d8fd62cbb1bca9974cfbeb7d (diff)
downloadsamba-5e9a136908fdc2955f8554fee83fff4c93ec998a.tar.gz
samba-5e9a136908fdc2955f8554fee83fff4c93ec998a.tar.bz2
samba-5e9a136908fdc2955f8554fee83fff4c93ec998a.zip
r4530: Start adding a bit of Doxygen compatible documentation comments to GENSEC.
Andrew Bartlett (This used to be commit c7acea9d5a097b51693f41de93274b857f7be0e3)
Diffstat (limited to 'source4/libcli/auth/gensec.c')
-rw-r--r--source4/libcli/auth/gensec.c26
1 files changed, 23 insertions, 3 deletions
diff --git a/source4/libcli/auth/gensec.c b/source4/libcli/auth/gensec.c
index 4a328d6d1c..fb638a9000 100644
--- a/source4/libcli/auth/gensec.c
+++ b/source4/libcli/auth/gensec.c
@@ -115,8 +115,11 @@ const char **gensec_security_oids(TALLOC_CTX *mem_ctx, const char *skip)
return oid_list;
}
-/*
- note that memory context is the parent context to hang this gensec context off. It may be NULL.
+/**
+ Start the GENSEC system, returning a context pointer.
+ @param mem_ctx The parent TALLOC memory context.
+ @param gensec_security Returned GENSEC context pointer.
+ @note The mem_ctx is only a parent and may be NULL.
*/
static NTSTATUS gensec_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security)
{
@@ -142,7 +145,9 @@ static NTSTATUS gensec_start(TALLOC_CTX *mem_ctx, struct gensec_security **gense
/**
* Start a GENSEC subcontext, with a copy of the properties of the parent
- *
+ * @param mem_ctx The parent TALLOC memory context.
+ * @param parent The parent GENSEC context
+ * @param gensec_security Returned GENSEC context pointer.
* @note Used by SPENGO in particular, for the actual implementation mechanism
*/
@@ -164,6 +169,12 @@ NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
return NT_STATUS_OK;
}
+/**
+ Start the GENSEC system, in client mode, returning a context pointer.
+ @param mem_ctx The parent TALLOC memory context.
+ @param gensec_security Returned GENSEC context pointer.
+ @note The mem_ctx is only a parent and may be NULL.
+*/
NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security)
{
NTSTATUS status;
@@ -179,6 +190,12 @@ NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx, struct gensec_security **gense
return status;
}
+/**
+ Start the GENSEC system, in server mode, returning a context pointer.
+ @param mem_ctx The parent TALLOC memory context.
+ @param gensec_security Returned GENSEC context pointer.
+ @note The mem_ctx is only a parent and may be NULL.
+*/
NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx, struct gensec_security **gensec_security)
{
NTSTATUS status;
@@ -222,6 +239,9 @@ static NTSTATUS gensec_start_mech(struct gensec_security *gensec_security)
/**
* Start a GENSEC sub-mechanism by DCERPC allocated 'auth type' number
+ * @param gensec_security GENSEC context pointer.
+ * @param auth_type DCERPC auth type
+ * @param auth_level DCERPC auth level
*/
NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,