svn commit: samba r13334 - in branches/SAMBA_4_0/source/librpc/rpc: .

[abartlet at samba.org]

Author: abartlet
Date: 2006-02-04 07:56:30 +0000 (Sat, 04 Feb 2006)
New Revision: 13334

WebSVN: http://websvn.samba.org/cgi-bin/viewcvs.cgi?view=rev&root=samba&rev=13334

Log:
Add comments describing what these functions do.

We still need many more, but it is a start...

Andrew Bartlett

Modified:
   branches/SAMBA_4_0/source/librpc/rpc/dcerpc_auth.c


Changeset:
Modified: branches/SAMBA_4_0/source/librpc/rpc/dcerpc_auth.c
===================================================================
--- branches/SAMBA_4_0/source/librpc/rpc/dcerpc_auth.c	2006-02-04 06:57:28 UTC (rev 13333)
+++ branches/SAMBA_4_0/source/librpc/rpc/dcerpc_auth.c	2006-02-04 07:56:30 UTC (rev 13334)
@@ -164,6 +164,18 @@
 	bind_auth_next_step(c);
 }
 
+/**
+   Bind to a DCE/RPC pipe, async
+   @param mem_ctx TALLOC_CTX for the allocation of the composite_context
+   @param p The dcerpc_pipe to bind (must already be connected)
+   @param table The interface table to use (the DCE/RPC bind both selects and interface and authenticates)
+   @param credentials The credentials of the account to connect with 
+   @param auth_type Select the authentication scheme to use
+   @param auth_level Chooses between unprotected (connect), signed or sealed
+   @param service The service (used by Kerberos to select the service principal to contact)
+   @retval A composite context describing the partial state of the bind
+*/
+
 struct composite_context *dcerpc_bind_auth_send(TALLOC_CTX *mem_ctx,
 						struct dcerpc_pipe *p,
 						const struct dcerpc_interface_table *table,
@@ -316,8 +328,15 @@
 	return result;
 }
 
-/*
-  setup GENSEC on a DCE-RPC pipe
+/**
+   Perform a GENSEC authenticated bind to a DCE/RPC pipe, sync
+   @param p The dcerpc_pipe to bind (must already be connected)
+   @param table The interface table to use (the DCE/RPC bind both selects and interface and authenticates)
+   @param credentials The credentials of the account to connect with 
+   @param auth_type Select the authentication scheme to use
+   @param auth_level Chooses between unprotected (connect), signed or sealed
+   @param service The service (used by Kerberos to select the service principal to contact)
+   @retval NTSTATUS status code
 */
 NTSTATUS dcerpc_bind_auth(struct dcerpc_pipe *p,
 			  const struct dcerpc_interface_table *table,