Merge pull request #25 from umbraco/feature/manually-add-api-key

Feature/manually add api key

Author: acoumb

src/Umbraco.AuthorizedServices/AuthorizedServicesComposer.cs

@@ -57,6 +57,7 @@ private static void RegisterServices(IUmbracoBuilder builder)
 
         builder.Services.AddUnique<ITokenFactory, TokenFactory>();
         builder.Services.AddUnique<ITokenStorage, DatabaseTokenStorage>();
+        builder.Services.AddUnique<IKeyStorage, DatabaseKeyStorage>();
 
         builder.Services.AddSingleton<JsonSerializerFactory>();
     }

src/Umbraco.AuthorizedServices/ClientApp/src/backoffice/AuthorizedServices/edit.controller.ts

@@ -14,11 +14,12 @@ function AuthorizedServiceEditController(this: any, $routeParams, $location, aut
         vm.isAuthorized = serviceData.isAuthorized;
         vm.authenticationMethod = serviceData.authenticationMethod;
         vm.canManuallyProvideToken = serviceData.canManuallyProvideToken;
+        vm.canManuallyProvideApiKey = serviceData.canManuallyProvideApiKey;
         vm.authorizationUrl = serviceData.authorizationUrl;
         vm.sampleRequest = serviceData.sampleRequest;
         vm.sampleRequestResponse = null;
         vm.settings = serviceData.settings;
-        vm.isApiKeyBasedAuthenticationMethod = serviceData.authenticationMethod === AuthenticationMethod.ApiKey;
+        vm.isOAuthBasedAuthenticationMethod = serviceData.authenticationMethod !== AuthenticationMethod.ApiKey;
       });
   }
 
@@ -67,6 +68,19 @@ function AuthorizedServiceEditController(this: any, $routeParams, $location, aut
     }
   }
 
+  vm.saveApiKey = function () {
+    let inApiKey = <HTMLInputElement>document.getElementById("inApiKey");
+
+    if (inApiKey) {
+      authorizedServiceResource.saveApiKey(serviceAlias, inApiKey.value)
+        .then(function () {
+          notificationsService.success("Authorized Services", "The '" + vm.displayName + "' service API key has been saved.");
+          inApiKey.value = "";
+          loadServiceDetails(serviceAlias);
+        });
+    }
+  }
+
   loadServiceDetails(serviceAlias);
 
 }

src/Umbraco.AuthorizedServices/ClientApp/src/backoffice/AuthorizedServices/edit.html

@@ -24,7 +24,8 @@
                             action="vm.sendSampleRequest()"
                             type="button"
                             label="Verify Sample Request"></umb-button>
-                <umb-button ng-if="!vm.isApiKeyBasedAuthenticationMethod"
+                <umb-button ng-if="vm.isOAuthBasedAuthenticationMethod
+                            || (!vm.isOAuthBasedAuthenticationMethod && vm.canManuallyProvideApiKey)"
                             action="vm.revokeAccess()"
                             type="button"
                             button-style="danger"
@@ -47,6 +48,7 @@
           </uui-icon-registry-essential>
         </umb-box-content>
       </umb-box>
+      <!-- Provide Token Section -->
       <umb-box ng-if="vm.canManuallyProvideToken">
         <umb-box-header title="Provide Token"></umb-box-header>
         <umb-box-content>
@@ -66,6 +68,29 @@
           </uui-icon-registry-essential>
         </umb-box-content>
       </umb-box>
+      <!-- Provide Key Section -->
+      <umb-box ng-if="vm.canManuallyProvideApiKey">
+        <umb-box-header title="Provide API key"></umb-box-header>
+        <umb-box-content>
+          <uui-icon-registry-essential>
+            <uui-card-content-node name="API Key">
+              <uui-icon slot="icon" name="add"></uui-icon>
+              <p class="auth-srv">Enter service API key</p>
+              <p>
+                This service is configured indicating that an API key can be created via the service's developer portal.
+                Once you have obtained one you can copy and paste it here to authorize the service.
+              </p>
+              <div>
+                <uui-input id="inApiKey" type="text" name="inApiKey" style="width: 40%;font-size:14px;"></uui-input>
+                <umb-button action="vm.saveApiKey()"
+                            type="button"
+                            button-style="primary"
+                            label="Save"></umb-button>
+              </div>
+            </uui-card-content-node>
+          </uui-icon-registry-essential>
+        </umb-box-content>
+      </umb-box>
       <umb-box>
         <umb-box-header title="Settings"></umb-box-header>
         <umb-box-content>

src/Umbraco.AuthorizedServices/ClientApp/src/resources/authorizedservice.resource.ts

@@ -17,6 +17,9 @@ function authorizedServiceResource($q, $http) {
     saveToken: function (alias: string, token: string) {
       return $http.post(apiRoot + "SaveToken", { alias: alias, token: token });
     },
+    saveApiKey: function (alias: string, apiKey: string) {
+      return $http.post(apiRoot + "SaveApiKey", { alias: alias, apiKey: apiKey });
+    },
     generateToken: function (alias: string) {
       return $http.post(apiRoot + "GenerateToken", { alias: alias });
     }

src/Umbraco.AuthorizedServices/Configuration/AuthorizedServiceSettings.cs

@@ -133,10 +133,15 @@ public class ServiceDetail : ServiceSummary
     public string TokenHost { get; set; } = string.Empty;
 
     /// <summary>
-    /// Get or sets a value indicating whether an adminsitrator editor can manually provide tokens via the backoffice.
+    /// Get or sets a value indicating whether an administrator can manually provide tokens via the backoffice.
     /// </summary>
     public bool CanManuallyProvideToken { get; set; }
 
+    /// <summary>
+    /// Get or sets a value indicating whether an administrator can manually provide API keys via the backoffice.
+    /// </summary>
+    public bool CanManuallyProvideApiKey { get; set; }
+
     /// <summary>
     /// Gets or sets the path for requests for authentication with the service.
     /// </summary>

src/Umbraco.AuthorizedServices/Constants.cs

@@ -44,10 +44,14 @@ public static class Trees
 
     public static class Migrations
     {
-        public const string TableName = "umbracoAuthorizedServiceToken";
+        public const string UmbracoAuthorizedServiceTokenTableName = "umbracoAuthorizedServiceToken";
+
+        public const string UmbracoAuthorizedServiceKeyTableName = "umbracoAuthorizedServiceKey";
 
         public const string MigrationPlan = "AuthorizedServicesDatabaseMigration";
 
-        public const string TargetState = "authorizedServices-db";
+        public const string UmbracoAuthorizedServiceTokenTargetState = "authorizedServices-token-db";
+
+        public const string UmbracoAuthorizedServiceKeyTargetState = "authorizedServices-key-db";
     }
 }

src/Umbraco.AuthorizedServices/Controllers/AuthorizedServiceController.cs

@@ -20,6 +20,7 @@ public class AuthorizedServiceController : BackOfficeNotificationsController
 {
     private readonly IOptionsMonitor<ServiceDetail> _serviceDetailOptions;
     private readonly ITokenStorage _tokenStorage;
+    private readonly IKeyStorage _keyStorage;
     private readonly IAuthorizationUrlBuilder _authorizationUrlBuilder;
     private readonly IAuthorizedServiceCaller _authorizedServiceCaller;
     private readonly IAuthorizationPayloadCache _authorizedServiceAuthorizationPayloadCache;
@@ -32,6 +33,7 @@ public class AuthorizedServiceController : BackOfficeNotificationsController
     public AuthorizedServiceController(
         IOptionsMonitor<ServiceDetail> serviceDetailOptions,
         ITokenStorage tokenStorage,
+        IKeyStorage keyStorage,
         IAuthorizationUrlBuilder authorizationUrlBuilder,
         IAuthorizedServiceCaller authorizedServiceCaller,
         IAuthorizationPayloadCache authorizedServiceAuthorizationPayloadCache,
@@ -40,6 +42,7 @@ public AuthorizedServiceController(
     {
         _serviceDetailOptions = serviceDetailOptions;
         _tokenStorage = tokenStorage;
+        _keyStorage = keyStorage;
         _authorizationUrlBuilder = authorizationUrlBuilder;
         _authorizedServiceCaller = authorizedServiceCaller;
         _authorizedServiceAuthorizationPayloadCache = authorizedServiceAuthorizationPayloadCache;
@@ -77,6 +80,7 @@ public AuthorizedServiceController(
             DisplayName = serviceDetail.DisplayName,
             IsAuthorized = isAuthorized,
             CanManuallyProvideToken = serviceDetail.CanManuallyProvideToken,
+            CanManuallyProvideApiKey = serviceDetail.CanManuallyProvideApiKey,
             AuthorizationUrl = authorizationUrl,
             AuthenticationMethod = serviceDetail.AuthenticationMethod.ToString(),
             SampleRequest = serviceDetail.SampleRequest,
@@ -120,13 +124,21 @@ public async Task<IActionResult> SendSampleRequest(string alias, string path)
     }
 
     /// <summary>
-    /// Revokes access by removing the access token for an authorized service.
+    /// Revokes access by removing the access token or API key for an authorized service.
     /// </summary>
     /// <param name="model">Request model identifying the service.</param>
     [HttpPost]
     public IActionResult RevokeAccess(RevokeAccess model)
     {
-        _tokenStorage.DeleteToken(model.Alias);
+        ServiceDetail serviceDetail = _serviceDetailOptions.Get(model.Alias);
+        if (serviceDetail.AuthenticationMethod != AuthenticationMethod.ApiKey)
+        {
+            _tokenStorage.DeleteToken(model.Alias);
+        }
+        else
+        {
+            _keyStorage.DeleteKey(model.Alias);
+        }
         return Ok();
     }
 
@@ -142,6 +154,18 @@ public IActionResult SaveToken(AddToken model)
         return Ok();
     }
 
+    /// <summary>
+    /// Adds a new API key for an authorized service.
+    /// </summary>
+    /// <param name="model">Request model identifying the service.</param>
+    /// <returns></returns>
+    [HttpPost]
+    public IActionResult SaveApiKey(AddApiKey model)
+    {
+        _keyStorage.SaveKey(model.Alias, model.ApiKey);
+        return Ok();
+    }
+
     /// <summary>
     /// Generates access token for an authorized service.
     /// </summary>
@@ -168,7 +192,8 @@ public async Task<IActionResult> GenerateToken(GenerateToken model)
         AuthenticationMethod.OAuth1 => false,
         AuthenticationMethod.OAuth2AuthorizationCode => StoredTokenExists(serviceDetail),
         AuthenticationMethod.OAuth2ClientCredentials => StoredTokenExists(serviceDetail),
-        AuthenticationMethod.ApiKey => !string.IsNullOrEmpty(serviceDetail.ApiKey),
+        AuthenticationMethod.ApiKey => !string.IsNullOrEmpty(serviceDetail.ApiKey)
+                                        || _keyStorage.GetKey(serviceDetail.Alias) is not null,
         _ => false
     };
 

src/Umbraco.AuthorizedServices/Migrations/AddDatabaseKeyStorageTable.cs

@@ -0,0 +1,26 @@
+using Microsoft.Extensions.Logging;
+using Umbraco.AuthorizedServices.Persistence.Dtos;
+using Umbraco.Cms.Infrastructure.Migrations;
+
+namespace Umbraco.AuthorizedServices.Migrations;
+
+public class AddDatabaseKeyStorageTable : MigrationBase
+{
+    public AddDatabaseKeyStorageTable(IMigrationContext context) : base(context)
+    {
+    }
+
+    protected override void Migrate()
+    {
+        Logger.LogDebug($"Running migration {nameof(AddDatabaseKeyStorageTable)}");
+
+        if (TableExists(Constants.Migrations.UmbracoAuthorizedServiceKeyTableName))
+        {
+            Logger.LogDebug($"The database table {Constants.Migrations.UmbracoAuthorizedServiceKeyTableName} already exists, skipping.");
+        }
+        else
+        {
+            Create.Table<KeyDto>().Do();
+        }
+    }
+}

src/Umbraco.AuthorizedServices/Migrations/AddDatabaseTokenStorageTable.cs

@@ -14,9 +14,9 @@ protected override void Migrate()
     {
         Logger.LogDebug($"Running migration {nameof(AddDatabaseTokenStorageTable)}");
 
-        if (TableExists(Constants.Migrations.TableName))
+        if (TableExists(Constants.Migrations.UmbracoAuthorizedServiceTokenTableName))
         {
-            Logger.LogDebug($"The database table {Constants.Migrations.TableName} already exists, skipping.");
+            Logger.LogDebug($"The database table {Constants.Migrations.UmbracoAuthorizedServiceTokenTableName} already exists, skipping.");
         }
         else
         {

src/Umbraco.AuthorizedServices/Migrations/AuthorizedServicesMigrationPlan.cs

@@ -20,6 +20,7 @@ public AuthorizedServicesMigrationPlan()
     /// <inheritdoc />
     protected override void DefinePlan()
     {
-        To<AddDatabaseTokenStorageTable>(Constants.Migrations.TargetState);
+        To<AddDatabaseTokenStorageTable>(Constants.Migrations.UmbracoAuthorizedServiceTokenTargetState);
+        To<AddDatabaseKeyStorageTable>(Constants.Migrations.UmbracoAuthorizedServiceKeyTargetState);
     }
 }