Dev/azure oauth

.github/workflows/asan.yml

@@ -33,6 +33,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - name: Setup MSVC Developer Command Prompt
         if: ${{ startsWith(matrix.os, 'windows') }}
         uses: ilammy/msvc-dev-cmd@v1

.github/workflows/build_rlclientlib.yml

@@ -29,6 +29,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - uses: lukka/get-cmake@latest
       - name: Install ONNX
         run: |
@@ -83,6 +84,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - uses: lukka/get-cmake@latest
       - run: echo "VCPKG_COMMIT=$(git rev-parse :ext_libs/vcpkg)" >> $GITHUB_ENV
         shell: bash
@@ -124,6 +126,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - name: Setup MSVC Developer Command Prompt
         uses: ilammy/msvc-dev-cmd@v1
       - uses: lukka/get-cmake@latest

.github/workflows/build_vw_bp.yml

@@ -38,6 +38,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - name: Setup MSVC Developer Command Prompt
         if: ${{ startsWith(matrix.config.os, 'windows') }}
         uses: ilammy/msvc-dev-cmd@v1

.github/workflows/codeql-analysis.yml

@@ -30,6 +30,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - uses: lukka/get-cmake@latest
       - run: echo "VCPKG_COMMIT=$(git rev-parse :ext_libs/vcpkg)" >> $GITHUB_ENV
         shell: bash
@@ -101,6 +102,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - name: Setup MSVC Developer Command Prompt
         uses: ilammy/msvc-dev-cmd@v1
       - uses: lukka/get-cmake@latest

.github/workflows/daily_integration.yml

@@ -18,6 +18,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - name: Update VW to latest
         shell: bash
         run: |

.github/workflows/run_benchmarks.yml

@@ -23,6 +23,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - uses: lukka/get-cmake@latest
       - run: echo "VCPKG_COMMIT=$(git rev-parse :ext_libs/vcpkg)" >> $GITHUB_ENV
         shell: bash

.github/workflows/vcpkg_build.yml

@@ -29,6 +29,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - run: git -C ${{ github.workspace }}/ext_libs/vcpkg fetch --unshallow
       - uses: lukka/get-cmake@latest
       - run: echo "VCPKG_COMMIT=$(git rev-parse :ext_libs/vcpkg)" >> $GITHUB_ENV
         shell: bash

CMakeLists.txt

@@ -33,6 +33,10 @@ if(RL_BUILD_BENCHMARKS)
   list(APPEND VCPKG_MANIFEST_FEATURES "benchmarks")
 endif()
 
+option(RL_LINK_AZURE_LIBS "Whether to build components requiring the use of Azure libraries. Requires C++14 or greater" OFF)
+if(RL_LINK_AZURE_LIBS)
+  list(APPEND VCPKG_MANIFEST_FEATURES "azurelibs")
+endif()
 project(reinforcement_learning)
 
 # Add support for building library with latest version of C++ supported by your compiler

examples/rl_sim_cpp/CMakeLists.txt

@@ -1,8 +1,25 @@
-add_executable(rl_sim_cpp.out
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_LIST_DIR}/../../cmake/Modules/")
+
+set(RL_SIM_SOURCES
   main.cc
   person.cc
   robot_joint.cc
   rl_sim.cc
 )
+if(RL_LINK_AZURE_LIBS)
+  list(APPEND RL_SIM_SOURCES
+    azure_credentials.cc
+  )
+endif()
+
+add_executable(rl_sim_cpp.out
+  ${RL_SIM_SOURCES}
+)
 
 target_link_libraries(rl_sim_cpp.out PRIVATE Boost::program_options rlclientlib)
+
+if(RL_LINK_AZURE_LIBS)
+  target_compile_definitions(rl_sim_cpp.out PRIVATE LINK_AZURE_LIBS)
+  find_package(azure-identity-cpp CONFIG REQUIRED)
+  target_link_libraries(rl_sim_cpp.out PRIVATE Azure::azure-identity)
+endif()

examples/rl_sim_cpp/azure_credentials.cc

@@ -0,0 +1,67 @@
+#ifdef LINK_AZURE_LIBS
+#  include "azure_credentials.h"
+
+#  include "err_constants.h"
+#  include "future_compat.h"
+
+#  include <azure/core/datetime.hpp>
+#  include <chrono>
+// These are needed because azure does a bad time conversion
+#  include <exception>
+#  include <iomanip>
+#  include <iostream>
+#  include <sstream>
+
+using namespace reinforcement_learning;
+
+AzureCredentials::AzureCredentials(const std::string& tenant_id) : _tenant_id(tenant_id), _creds(create_options()) {}
+
+Azure::Identity::AzureCliCredentialOptions AzureCredentials::create_options()
+{
+  Azure::Identity::AzureCliCredentialOptions options;
+  options.TenantId = _tenant_id;
+  options.AdditionallyAllowedTenants.push_back("*");
+  return options;
+}
+
+int AzureCredentials::get_credentials(
+    const std::vector<std::string>& scopes, std::string& token_out, std::chrono::system_clock::time_point& expiry_out)
+{
+#  ifdef HAS_STD14
+  Azure::Core::Credentials::TokenRequestContext request_context;
+  request_context.Scopes = scopes;
+  // TODO: needed?
+  request_context.TenantId = _tenant_id;
+  Azure::Core::Context context;
+  try
+  {
+    auto auth = _creds.GetToken(request_context, context);
+    token_out = auth.Token;
+
+    // Casting from an azure DateTime object to a time_point does the calculation
+    // incorrectly. The expiration is returned as a local time, but the library
+    // assumes that it is GMT, and converts the value incorrectly.
+    // See: https://github.com/Azure/azure-sdk-for-cpp/issues/5075
+    // expiry_out = static_cast<std::chrono::system_clock::time_point>(auth.ExpiresOn);
+    std::string dt_string = auth.ExpiresOn.ToString();
+    std::tm tm = {};
+    std::istringstream ss(dt_string);
+    ss >> std::get_time(&tm, "%Y-%m-%dT%H:%M:%SZ");
+    expiry_out = std::chrono::system_clock::from_time_t(std::mktime(&tm));
+  }
+  catch (std::exception& e)
+  {
+    std::cout << "Error getting auth token: " << e.what();
+    return error_code::external_error;
+  }
+  catch (...)
+  {
+    std::cout << "Unknown error while getting auth token";
+    return error_code::external_error;
+  }
+#  else
+#    error Requires C++14 or greater
+#  endif
+  return error_code::success;
+}
+#endif

examples/rl_sim_cpp/azure_credentials.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#ifdef LINK_AZURE_LIBS
+#  include "api_status.h"
+#  include "configuration.h"
+#  include "future_compat.h"
+
+#  include <azure/identity/azure_cli_credential.hpp>
+#  include <azure/identity/default_azure_credential.hpp>
+#  include <chrono>
+#  include <memory>
+#  include <string>
+
+class AzureCredentials
+{
+public:
+  AzureCredentials(const std::string& tenant_id);
+  int get_credentials(const std::vector<std::string>& scopes, std::string& token_out,
+      std::chrono::system_clock::time_point& expiry_out);
+
+private:
+  std::string _tenant_id;
+#  ifdef HAS_STD14
+  Azure::Identity::AzureCliCredentialOptions create_options();
+
+  // Azure::Identity::DefaultAzureCredential _creds;
+  Azure::Identity::AzureCliCredential _creds;
+#  endif
+};
+#endif

examples/rl_sim_cpp/main.cc

@@ -38,7 +38,9 @@ po::variables_map process_cmd_line(const int argc, char** argv)
       "random_seed", po::value<uint64_t>()->default_value(rand()), "Random seed. Default is random")(
       "delay", po::value<int64_t>()->default_value(2000), "Delay between events in ms")(
       "quiet", po::bool_switch(), "Suppress logs")("random_ids", po::value<bool>()->default_value(true),
-      "Use randomly generated Event IDs. Default is true")("throughput", "print throughput stats");
+      "Use randomly generated Event IDs. Default is true")("throughput", "print throughput stats")(
+      "azure_oauth_factories", po::value<bool>()->default_value(false), "Use oauth for azure factores. Default false")(
+      "azure_tenant_id", po::value<std::string>()->default_value(""), "Tenant ID for use with azure oauth factories.");
 
   po::variables_map vm;
   store(parse_command_line(argc, argv, desc), vm);

examples/rl_sim_cpp/rl_sim.cc

@@ -1,6 +1,7 @@
 #include "api_status.h"
 #include "constants.h"
 #include "factory_resolver.h"
+#include "future_compat.h"
 #include "live_model.h"
 #include "multistep.h"
 #include "person.h"
@@ -13,6 +14,7 @@
 #include <boost/uuid/uuid_io.hpp>
 #include <chrono>
 #include <cmath>
+#include <functional>
 #include <thread>
 
 using namespace std;
@@ -487,6 +489,17 @@ int rl_sim::init_rl()
         wrap_sender_generate_for_throughput_sender(reinforcement_learning::value::EPISODE_HTTP_API_SENDER));
     sender_factory = &factory;
   }
+  // probably incompatible with the throughput option?
+  else if (_options["azure_oauth_factories"].as<bool>())
+  {
+#ifdef LINK_AZURE_LIBS
+    // Note: This requires C++14 or better
+    using namespace std::placeholders;
+    reinforcement_learning::oauth_callback_t callback =
+        std::bind(&AzureCredentials::get_credentials, &_creds, _1, _2, _3);
+    reinforcement_learning::register_default_factories_callback(callback);
+#endif
+  }
 
   // Initialize the API
   _rl = std::unique_ptr<r::live_model>(new r::live_model(config, _on_error, this,
@@ -637,7 +650,12 @@ std::string rl_sim::create_event_id()
   return oss.str();
 }
 
-rl_sim::rl_sim(boost::program_options::variables_map vm) : _options(std::move(vm)), _loop_kind(CB)
+rl_sim::rl_sim(boost::program_options::variables_map vm)
+    : _options(std::move(vm))
+    , _loop_kind(CB)
+#ifdef LINK_AZURE_LIBS
+    , _creds(_options["azure_tenant_id"].as<std::string>())
+#endif
 {
   if (_options["ccb"].as<bool>()) { _loop_kind = CCB; }
   else if (_options["slates"].as<bool>()) { _loop_kind = Slates; }
@@ -699,4 +717,4 @@ std::string get_dist_str(const reinforcement_learning::decision_response& respon
   }
   ret += ")";
   return ret;
-}
+}

examples/rl_sim_cpp/rl_sim.h

@@ -6,6 +6,7 @@
  * @date 2018-07-18
  */
 #pragma once
+#include "azure_credentials.h"
 #include "live_model.h"
 #include "person.h"
 #include "robot_joint.h"
@@ -177,4 +178,7 @@ class rl_sim
   int64_t _delay = 2000;
   bool _quiet = false;
   bool _random_ids = true;
+#ifdef LINK_AZURE_LIBS
+  AzureCredentials _creds;
+#endif
 };

include/constants.h

@@ -26,6 +26,7 @@ const char* const LEARNING_MODE = "rank.learning.mode";
 const char* const PROTOCOL_VERSION = "protocol.version";
 const char* const HTTP_API_KEY = "http.api.key";
 const char* const HTTP_API_HEADER_KEY_NAME = "http.api.header.key.name";
+const char* const HTTP_API_OAUTH_TOKEN_TYPE = "http.api.oauth.token.type";
 const char* const AUDIT_ENABLED = "audit.enabled";
 const char* const AUDIT_OUTPUT_PATH = "audit.output.path";
 
@@ -118,6 +119,7 @@ const char* const AZURE_STORAGE_BLOB = "AZURE_STORAGE_BLOB";
 const char* const NO_MODEL_DATA = "NO_MODEL_DATA";
 const char* const HTTP_MODEL_DATA = "HTTP_MODEL_DATA";
 const char* const FILE_MODEL_DATA = "FILE_MODEL_DATA";
+const char* const HTTP_MODEL_DATA_OAUTH = "HTTP_MODEL_DATA_OAUTH";
 const char* const VW = "VW";
 const char* const PASSTHROUGH_PDF_MODEL = "PASSTHROUGH_PDF";
 const char* const EPISODE_EH_SENDER = "EPISODE_EH_SENDER";
@@ -129,6 +131,9 @@ const char* const INTERACTION_FILE_SENDER = "INTERACTION_FILE_SENDER";
 const char* const EPISODE_HTTP_API_SENDER = "EPISODE_HTTP_API_SENDER";
 const char* const OBSERVATION_HTTP_API_SENDER = "OBSERVATION_HTTP_API_SENDER";
 const char* const INTERACTION_HTTP_API_SENDER = "INTERACTION_HTTP_API_SENDER";
+const char* const EPISODE_HTTP_API_SENDER_OAUTH = "EPISODE_HTTP_API_SENDER_OAUTH";
+const char* const OBSERVATION_HTTP_API_SENDER_OAUTH = "OBSERVATION_HTTP_API_SENDER_OAUTH";
+const char* const INTERACTION_HTTP_API_SENDER_OAUTH = "INTERACTION_HTTP_API_SENDER_OAUTH";
 const char* const NULL_TRACE_LOGGER = "NULL_TRACE_LOGGER";
 const char* const CONSOLE_TRACE_LOGGER = "CONSOLE_TRACE_LOGGER";
 const char* const NULL_TIME_PROVIDER = "NULL_TIME_PROVIDER";
@@ -139,6 +144,7 @@ const char* const LEARNING_MODE_LOGGINGONLY = "LOGGINGONLY";
 const char* const CONTENT_ENCODING_IDENTITY = "IDENTITY";
 const char* const CONTENT_ENCODING_DEDUP = "DEDUP";
 const char* const HTTP_API_DEFAULT_HEADER_KEY_NAME = "Ocp-Apim-Subscription-Key";
+const char* const HTTP_API_DEFAULT_OAUTH_TOKEN_TYPE = "Bearer";
 const char* const TRACE_LOG_LEVEL_DEFAULT = "info";
 
 const char* const QUEUE_MODE_DROP = "DROP";

include/factory_resolver.h

@@ -1,5 +1,9 @@
 #pragma once
+#include "oauth_callback_fn.h"
 #include "object_factory.h"
+
+#include <chrono>
+#include <vector>
 namespace reinforcement_learning
 {
 namespace utility
@@ -70,4 +74,11 @@ struct factory_initializer
 // Every translation unit gets a factory_initializer
 // only one translation unit will initialize it
 static factory_initializer _init;
+
+// no-op if USE_AZURE_FACTORIES is not defined
+/**
+ * @brief Register default factories with an authentication callback
+ */
+void register_default_factories_callback(oauth_callback_t& callback);
+
 }  // namespace reinforcement_learning

include/oauth_callback_fn.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <chrono>
+#include <functional>
+#include <string>
+#include <vector>
+
+namespace reinforcement_learning
+{
+using oauth_callback_t =
+    std::function<int(const std::vector<std::string>&, std::string&, std::chrono::system_clock::time_point&)>;
+}