Adding random adapter (#654)

* Adding random

* Disabling MACOSX random

* prototype fix

* Flag comment

Author: RLeclair

CMakeLists.txt

@@ -232,7 +232,6 @@ set(source_c_files
     ./src/gbnetwork.c
     ./src/gb_stdio.c
     ./src/gb_time.c
-    ./src/gb_rand.c
     ./src/hmac.c
     ./src/hmacsha256.c
     ./src/xio.c
@@ -257,6 +256,7 @@ set(source_c_files
     ${LOCK_C_FILE}
     ${SRW_LOCK_C_FILE}
     ${TIMER_C_FILE}
+    ${RANDOM_C_FILE}
     ${STRING_UTILS_C_FILE}
     ${PLATFORM_C_FILE}
     ${SOCKETIO_C_FILE}
@@ -356,7 +356,6 @@ set(source_h_files
     ./inc/azure_c_shared_utility/gbnetwork.h
     ./inc/azure_c_shared_utility/gb_stdio.h
     ./inc/azure_c_shared_utility/gb_time.h
-    ./inc/azure_c_shared_utility/gb_rand.h
     ./inc/azure_c_shared_utility/hmac.h
     ./inc/azure_c_shared_utility/hmacsha256.h
     ./inc/azure_c_shared_utility/http_proxy_io.h

adapters/random_posix.c

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+#ifdef __cplusplus
+#include <cstdlib>
+#else
+#include <stdlib.h>
+#endif
+
+#include "azure_c_shared_utility/random.h"
+
+void RANDOM_seed(unsigned int seed)
+{
+  srandom(seed);
+}
+
+int RANDOM_generate(void)
+{
+  return random();
+}

src/gb_rand.c adapters/random_stub.csrc/gb_rand.c renamed to adapters/random_stub.c

@@ -7,10 +7,14 @@
 #include <stdlib.h>
 #endif
 
-#include "azure_c_shared_utility/gb_rand.h"
+#include "azure_c_shared_utility/random.h"
 
-/*this is rand*/
-int gb_rand(void)
+void RANDOM_seed(unsigned int seed)
 {
-    return rand();
+  srand(seed);
+}
+
+int RANDOM_generate(void)
+{
+  return rand();
 }

configs/azure_c_shared_utilityFunctions.cmake

@@ -700,6 +700,7 @@ function(set_platform_files c_shared_dir)
         set(SRW_LOCK_C_FILE ${c_shared_dir}/adapters/srw_lock.c PARENT_SCOPE)
         set(TIMER_C_FILE ${c_shared_dir}/adapters/timer.c PARENT_SCOPE)
         set(STRING_UTILS_C_FILE ${c_shared_dir}/adapters/string_utils.c PARENT_SCOPE)
+        set(RANDOM_C_FILE ${c_shared_dir}/adapters/random_stub.c PARENT_SCOPE)
 
         if (${use_builtin_httpapi})
             set(HTTP_C_FILE ${c_shared_dir}/adapters/httpapi_compact.c PARENT_SCOPE)
@@ -754,6 +755,12 @@ function(set_platform_files c_shared_dir)
         else()
             set(DNS_C_FILE ${c_shared_dir}/src/dns_resolver_sync.c PARENT_SCOPE)
         endif()
+
+        if(UNIX AND NOT MACOSX)
+          set(RANDOM_C_FILE ${c_shared_dir}/adapters/random_posix.c PARENT_SCOPE)
+        else()
+          set(RANDOM_C_FILE ${c_shared_dir}/adapters/random_stub.c PARENT_SCOPE)
+        endif()
     endif()
 
     if(WIN32 OR MACOSX OR LINUX)

configs/azure_iot_build_rules.cmake

@@ -74,7 +74,8 @@ elseif(UNIX) #LINUX OR APPLE
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror")
     if(NOT (IN_OPENWRT OR APPLE))
-        set (CMAKE_C_FLAGS "-D_POSIX_C_SOURCE=200112L ${CMAKE_C_FLAGS}")
+        # _XOPEN_SOURCE=500 is required for glibc to expose random and srandom.
+        set (CMAKE_C_FLAGS "-D_POSIX_C_SOURCE=200112L -D_XOPEN_SOURCE=500 ${CMAKE_C_FLAGS}")
     endif()
 endif()
 

devdoc/uws_frame_encoder_requirements.md

@@ -64,7 +64,7 @@ extern int uws_frame_encoder_encode(BUFFER_HANDLE encode_buffer, WS_FRAME_TYPE o
 
 **SRS_UWS_FRAME_ENCODER_01_052: [** If `reserved` has any bits set except the lowest 3 then `uws_frame_encoder_encode` shall fail and return NULL. **]**
 
-**SRS_UWS_FRAME_ENCODER_01_053: [** In order to obtain a 32 bit value for masking, `gb_rand` shall be used 4 times (for each byte). **]**
+**SRS_UWS_FRAME_ENCODER_01_053: [** In order to obtain a 32 bit value for masking, `RANDOM_generate` shall be used 4 times (for each byte). **]**
 
 ###  RFC6455 relevant parts
 

inc/azure_c_shared_utility/gb_rand.h inc/azure_c_shared_utility/random.hinc/azure_c_shared_utility/gb_rand.h renamed to inc/azure_c_shared_utility/random.h

@@ -1,19 +1,20 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-#ifndef GB_RAND_H
-#define GB_RAND_H
+#ifndef RANDOM_H
+#define RANDOM_H
 
 #include "umock_c/umock_c_prod.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-MOCKABLE_FUNCTION(, int, gb_rand);
+MOCKABLE_FUNCTION(, void, RANDOM_seed, unsigned int, seed);
+MOCKABLE_FUNCTION(, int, RANDOM_generate);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* GB_RAND_H */
+#endif /* RANDOM_H */

src/aziotsharedutil.def

@@ -129,6 +129,8 @@ EXPORTS
     STRING_quote
     STRING_sprintf
     STRING_replace
+    RANDOM_seed
+    RANDOM_generate
     THREADAPI_RESULTStringStorage
     THREADAPI_RESULTStrings
     THREADAPI_RESULT_FromString
@@ -174,7 +176,6 @@ EXPORTS
     connectionstringparser_splitHostName_from_char
     consolelogger_log
     consolelogger_log_with_GetLastError
-    gb_rand
     gballoc_calloc
     gballoc_deinit
     gballoc_free

src/uws_client.c

@@ -20,7 +20,7 @@
 #include "azure_c_shared_utility/uws_frame_encoder.h"
 #include "azure_c_shared_utility/crt_abstractions.h"
 #include "azure_c_shared_utility/utf8_checker.h"
-#include "azure_c_shared_utility/gb_rand.h"
+#include "azure_c_shared_utility/random.h"
 #include "azure_c_shared_utility/azure_base64.h"
 #include "azure_c_shared_utility/optionhandler.h"
 #include "azure_c_shared_utility/map.h"
@@ -780,7 +780,7 @@ static void on_underlying_io_open_complete(void* context, IO_OPEN_RESULT open_re
                 /* Codes_SRS_UWS_CLIENT_01_090: [ The nonce MUST be selected randomly for each connection. ]*/
                 for (i = 0; i < sizeof(nonce); i++)
                 {
-                    nonce[i] = (unsigned char)gb_rand();
+                    nonce[i] = (unsigned char)RANDOM_generate();
                 }
 
                 /* Codes_SRS_UWS_CLIENT_01_497: [ The nonce needed for the upgrade request shall be Base64 encoded with Azure_Base64_Encode_Bytes. ]*/

src/uws_frame_encoder.c

@@ -5,7 +5,7 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include "azure_c_shared_utility/gballoc.h"
-#include "azure_c_shared_utility/gb_rand.h"
+#include "azure_c_shared_utility/random.h"
 #include "azure_c_shared_utility/uws_frame_encoder.h"
 #include "azure_c_shared_utility/xlogging.h"
 #include "azure_c_shared_utility/buffer_.h"
@@ -148,17 +148,17 @@ BUFFER_HANDLE uws_frame_encoder_encode(WS_FRAME_TYPE opcode, const unsigned char
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_033: [ A masked frame MUST have the field frame-masked set to 1, as defined in Section 5.2. ]*/
                         buffer[1] |= 0x80;
 
-                        /* Codes_SRS_UWS_FRAME_ENCODER_01_053: [ In order to obtain a 32 bit value for masking, gb_rand shall be used 4 times (for each byte). ]*/
+                        /* Codes_SRS_UWS_FRAME_ENCODER_01_053: [ In order to obtain a 32 bit value for masking, RANDOM_generate shall be used 4 times (for each byte). ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_016: [ If set to 1, a masking key is present in masking-key, and this is used to unmask the "Payload data" as per Section 5.3. ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_026: [ This field is present if the mask bit is set to 1 and is absent if the mask bit is set to 0. ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_034: [ The masking key is contained completely within the frame, as defined in Section 5.2 as frame-masking-key. ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_036: [ The masking key is a 32-bit value chosen at random by the client. ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_037: [ When preparing a masked frame, the client MUST pick a fresh masking key from the set of allowed 32-bit values. ]*/
                         /* Codes_SRS_UWS_FRAME_ENCODER_01_038: [ The masking key needs to be unpredictable; thus, the masking key MUST be derived from a strong source of entropy, and the masking key for a given frame MUST NOT make it simple for a server/proxy to predict the masking key for a subsequent frame. ]*/
-                        buffer[header_bytes - 4] = (unsigned char)gb_rand();
-                        buffer[header_bytes - 3] = (unsigned char)gb_rand();
-                        buffer[header_bytes - 2] = (unsigned char)gb_rand();
-                        buffer[header_bytes - 1] = (unsigned char)gb_rand();
+                        buffer[header_bytes - 4] = (unsigned char)RANDOM_generate();
+                        buffer[header_bytes - 3] = (unsigned char)RANDOM_generate();
+                        buffer[header_bytes - 2] = (unsigned char)RANDOM_generate();
+                        buffer[header_bytes - 1] = (unsigned char)RANDOM_generate();
                     }
 
                     if (length > 0)