Diff: http/server/HttpAuth.h

Revision:

0:400d8e75a8d0

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/http/server/HttpAuth.h	Sun Sep 06 15:19:36 2015 +0000
@@ -0,0 +1,91 @@
+//*****************************************************************************
+// Copyright (C) 2014 Texas Instruments Incorporated
+//
+// All rights reserved. Property of Texas Instruments Incorporated.
+// Restricted rights to use, duplicate or disclose this code are
+// granted through contract.
+// The program may not be used without the written permission of
+// Texas Instruments Incorporated or against the terms and conditions
+// stipulated in the agreement under which this program has been supplied,
+// and under no circumstances can it be used with non-TI connectivity device.
+//
+//*****************************************************************************
+
+/**
+ * @defgroup HttpAuth
+ *
+ * @{
+ */
+
+#ifndef _HTTP_AUTH_H_
+#define _HTTP_AUTH_H_
+
+#include "HttpConfig.h"
+#include "HttpString.h"
+#include "HttpRequest.h"
+#ifdef HTTP_CORE_ENABLE_AUTH
+
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
+/** 
+ * @defgroup HttpAuth HTTP Authentication
+ * This module implements the HTTP digest access authentication routines.
+ * Note this module is only compiled if HTTP_CORE_ENABLE_AUTH is defined in HttpConfig.h
+ * 
+ * When a "not authorized" response is sent to the client, the WWW-Authenticate header is built using HttpAuth_ResponseAuthenticate()
+ * This in turn generates new nonce and opaque values which will be used for authentication.
+ * Note that since only a single nonce is kept, only one client may ever be authenticated simultaneously.
+ * When another request with Authorization header is received, it is verified using HttpAuth_RequestAuthenticate()
+ * If all authentication tests pass, then the appropriate flag is set in the request to indicate that.
+ *
+ * @{
+ */
+
+/**
+ * Initialize the authentication module, so that it accepts the specified username and password
+ * This function should be called during server initialization in order to set initial user credentials
+ * This function may then be called at any time during the operation of the server in order to set different user credentials
+ * @param username The authorized user's username 
+ * @param password The authorized user's password
+ */
+void HttpAuth_Init(struct HttpBlob username, struct HttpBlob password);
+
+/**
+ * Builds and returns the WWW-Authenticate response header.
+ * This implies generating a new nonce, etc.
+ * Notes about return value:
+ *     Upon entry, pWWWAuthenticate should point to the place in the packet-send buffer where the header needs to be generated, and also specify the maximum amount of bytes available for the header at that place
+ *     Upon return, pWWWAuthenticate points to the same location, but specifies the actual length of the header.
+ *     If the returned length is 0, this means that there was not enough room in the buffer for the header.
+ *     In such a case, the core may try again with a larger buffer
+ * @param pRequest All data about the request
+ * @param[in,out] pWWWAuthenticate On entry specifies the memory location to build the header at, and the maximum size. On return, specifies the same location and the actual size of the header line
+ */
+void HttpAuth_ResponseAuthenticate(struct HttpRequest* pRequest, struct HttpBlob* pWWWAuthenticate);
+
+/**
+ * Check the authentication header in a request, and either authorize the request or deny it
+ * If the authorization succeeds, then HTTP_REQUEST_FLAG_AUTHENTICATED is added to the request flags
+ * @param pRequest All data about the request to authorize
+ * @param authorization The full string of the Authorization header
+ */
+void HttpAuth_RequestAuthenticate(struct HttpRequest* pRequest, struct HttpBlob authorization);
+
+static UINT16 HttpAuth_VerifyHeaderNameValue(struct HttpBlob *location, char* nameToken, UINT8 tokenlenLen, char *value, UINT8 valuelen, char** outValue);
+static void AddStringToBlob(struct HttpBlob * trgt, char *str, UINT16 length);
+static void Generate32BytesRandomString(UINT8 *str);
+static void MD5_FinalToString(UINT8* str, MD5_CTX *md5stat);
+static UINT32 GetRandomUint(void);
+
+
+/// @}
+#ifdef  __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif // HTTP_CORE_ENABLE_AUTH
+
+#endif // _HTTP_AUTH_H_
+