[open-ils-commits] r15867 - trunk/Open-ILS/src/c-apps (scottmk)

[svn at svn.open-ils.org]

Author: scottmk
Date: 2010-03-16 11:54:43 -0400 (Tue, 16 Mar 2010)
New Revision: 15867

Modified:
   trunk/Open-ILS/src/c-apps/oils_auth.c
Log:
Added doxygen-style comments to several functions.

Also, in oilsAuthInit():

1. Moved the declarations of several variables closer to their first uses.

2. Instead of using va_list_to_string() to build a seed, exploit the fact that
md5sum() builds its input using printf-style formatting.  This change eliminates
a malloc(), a free(), and two calls to vsprintf().

M    Open-ILS/src/c-apps/oils_auth.c


Modified: trunk/Open-ILS/src/c-apps/oils_auth.c
===================================================================
--- trunk/Open-ILS/src/c-apps/oils_auth.c	2010-03-16 15:44:51 UTC (rev 15866)
+++ trunk/Open-ILS/src/c-apps/oils_auth.c	2010-03-16 15:54:43 UTC (rev 15867)
@@ -23,6 +23,10 @@
 static int _oilsAuthOverrideTimeout = 0;
 
 
+/**
+	@brief Initialize the application by registering functions for method calls.
+	@return Zero in all cases.
+*/
 int osrfAppInitialize() {
 
 	osrfLogInfo(OSRF_LOG_MARK, "Initializing Auth Server...");
@@ -77,52 +81,72 @@
 	return 0;
 }
 
+/**
+	@brief Dummy placeholder for initializing a server drone.
+
+	There is nothing to do, so do nothing.
+*/
 int osrfAppChildInit() {
 	return 0;
 }
 
+/**
+	@brief Implement the init method.
+	@param ctx The method context.
+	@return Zero if successful, or -1 if not.
+
+	Method parameters:
+	- username
+
+	Return to client: Intermediate authentication seed.
+
+	Combine the username with a timestamp and process ID, and take an md5 hash of the result.
+	Store the hash in memcache, with a key based on the username.  Then return the hash to
+	the client.
+
+	However: if the username includes one or more embedded blank spaces, return a dummy
+	hash without storing anything in memcache.  The dummy will never match a stored hash, so
+	any attempt to authenticate with it will fail.
+*/
 int oilsAuthInit( osrfMethodContext* ctx ) {
 	OSRF_METHOD_VERIFY_CONTEXT(ctx);
 
-	jsonObject* resp;
+	char* username  = jsonObjectToSimpleString( jsonObjectGetIndex(ctx->params, 0) );
+	if( username ) {
 
-	char* username  = NULL;
-	char* seed      = NULL;
-	char* md5seed   = NULL;
-	char* key       = NULL;
+		jsonObject* resp;
 
-	if( (username = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, 0))) ) {
-
 		if( strchr( username, ' ' ) ) {
 
-			/* spaces are not allowed */
-			resp = jsonNewObject("x");     /* 'x' will never be a valid seed */
-			osrfAppRespondComplete( ctx, resp );
+			// Embedded spaces are not allowed in a username.  Use "x" as a dummy
+			// seed.  It will never be a valid seed because 'x' is not a hex digit.
+			resp = jsonNewObject( "x" );
 
 		} else {
 
-			seed = va_list_to_string( "%d.%ld.%s", time(NULL), (long) getpid(), username );
-			key = va_list_to_string( "%s%s", OILS_AUTH_CACHE_PRFX, username );
+			// Build a key and a seed; store them in memcache.
+			char* key  = va_list_to_string( "%s%s", OILS_AUTH_CACHE_PRFX, username );
+			char* seed = md5sum( "%d.%ld.%s", (int) time(NULL), (long) getpid(), username );
+			osrfCachePutString( key, seed, 30 );
 
-			md5seed = md5sum(seed);
-			osrfCachePutString( key, md5seed, 30 );
+			osrfLogDebug( OSRF_LOG_MARK, "oilsAuthInit(): has seed %s and key %s", seed, key );
 
-			osrfLogDebug( OSRF_LOG_MARK, "oilsAuthInit(): has seed %s and key %s", md5seed, key );
+			// Build a returnable object containing the seed.
+			resp = jsonNewObject( seed );
 
-			resp = jsonNewObject(md5seed);
-			osrfAppRespondComplete( ctx, resp );
-
-			free(seed);
-			free(md5seed);
-			free(key);
+			free( seed );
+			free( key );
 		}
 
+		// Return the seed to the client.
+		osrfAppRespondComplete( ctx, resp );
+
 		jsonObjectFree(resp);
 		free(username);
 		return 0;
 	}
 
-	return -1;
+	return -1;  // Error: no username parameter
 }
 
 /**