Merge pull request #87 from acjh/patch-2

Add swagger authentication helpers

Author: ismcagdas

aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/Startup/Startup.cs

@@ -107,6 +107,8 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
             // Enable middleware to serve swagger-ui assets (HTML, JS, CSS etc.)
             app.UseSwaggerUI(options =>
             {
+                options.InjectOnCompleteJavaScript("/swagger/ui/abp.js");
+                options.InjectOnCompleteJavaScript("/swagger/ui/on-complete.js");
                 options.SwaggerEndpoint("/swagger/v1/swagger.json", "AbpProjectName API V1");
             }); //URL: /swagger
         }

aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/wwwroot/swagger/ui/abp.js

@@ -0,0 +1,117 @@
+var abp = abp || {};
+(function () {
+
+    /* Application paths *****************************************/
+
+    //Current application root path (including virtual directory if exists).
+    abp.appPath = abp.appPath || '/';
+
+    /* AUTHORIZATION **********************************************/
+    //Implements Authorization API that simplifies usage of authorization scripts generated by Abp.
+
+    abp.auth = abp.auth || {};
+
+    abp.auth.tokenCookieName = 'Abp.AuthToken';
+    abp.auth.tokenHeaderName = 'Authorization';
+
+    abp.auth.setToken = function (authToken, expireDate) {
+        abp.utils.setCookieValue(abp.auth.tokenCookieName, authToken, expireDate, abp.appPath);
+    };
+
+    abp.auth.getToken = function () {
+        return abp.utils.getCookieValue(abp.auth.tokenCookieName);
+    }
+
+    abp.auth.clearToken = function () {
+        abp.auth.setToken();
+    }
+
+    /* UTILS ***************************************************/
+
+    abp.utils = abp.utils || {};
+
+    /**
+         * Sets a cookie value for given key.
+         * This is a simple implementation created to be used by ABP.
+         * Please use a complete cookie library if you need.
+         * @param {string} key
+         * @param {string} value
+         * @param {Date} expireDate (optional). If not specified the cookie will expire at the end of session.
+         * @param {string} path (optional)
+         */
+    abp.utils.setCookieValue = function (key, value, expireDate, path) {
+        var cookieValue = encodeURIComponent(key) + '=';
+
+        if (value) {
+            cookieValue = cookieValue + encodeURIComponent(value);
+        }
+
+        if (expireDate) {
+            cookieValue = cookieValue + "; expires=" + expireDate.toUTCString();
+        }
+
+        if (path) {
+            cookieValue = cookieValue + "; path=" + path;
+        }
+
+        document.cookie = cookieValue;
+    };
+
+    /**
+     * Gets a cookie with given key.
+     * This is a simple implementation created to be used by ABP.
+     * Please use a complete cookie library if you need.
+     * @param {string} key
+     * @returns {string} Cookie value or null
+     */
+    abp.utils.getCookieValue = function (key) {
+        var equalities = document.cookie.split('; ');
+        for (var i = 0; i < equalities.length; i++) {
+            if (!equalities[i]) {
+                continue;
+            }
+
+            var splitted = equalities[i].split('=');
+            if (splitted.length != 2) {
+                continue;
+            }
+
+            if (decodeURIComponent(splitted[0]) === key) {
+                return decodeURIComponent(splitted[1] || '');
+            }
+        }
+
+        return null;
+    };
+
+    /**
+     * Deletes cookie for given key.
+     * This is a simple implementation created to be used by ABP.
+     * Please use a complete cookie library if you need.
+     * @param {string} key
+     * @param {string} path (optional)
+     */
+    abp.utils.deleteCookie = function (key, path) {
+        var cookieValue = encodeURIComponent(key) + '=';
+
+        cookieValue = cookieValue + "; expires=" + (new Date(new Date().getTime() - 86400000)).toUTCString();
+
+        if (path) {
+            cookieValue = cookieValue + "; path=" + path;
+        }
+
+        document.cookie = cookieValue;
+    }
+
+    /* SECURITY ***************************************/
+    abp.security = abp.security || {};
+    abp.security.antiForgery = abp.security.antiForgery || {};
+
+    abp.security.antiForgery.tokenCookieName = 'XSRF-TOKEN';
+    abp.security.antiForgery.tokenHeaderName = 'X-XSRF-TOKEN';
+
+    abp.security.antiForgery.getToken = function () {
+        return abp.utils.getCookieValue(abp.security.antiForgery.tokenCookieName);
+    };
+
+})();

aspnet-core/src/AbpCompanyName.AbpProjectName.Web.Host/wwwroot/swagger/ui/on-complete.js

@@ -0,0 +1,55 @@
+var abp = abp || {};
+(function () {
+
+    /* Swagger */
+
+    abp.swagger = abp.swagger || {};
+
+    abp.swagger.addAuthToken = function () {
+        var authToken = abp.auth.getToken();
+        if (!authToken) {
+            return false;
+        }
+        var cookieAuth = new SwaggerClient.ApiKeyAuthorization(abp.auth.tokenHeaderName, 'Bearer ' + authToken, 'header');
+        swaggerUi.api.clientAuthorizations.add(abp.auth.tokenHeaderName, cookieAuth);
+        return true;
+    }
+
+    abp.swagger.addCsrfToken = function () {
+        var csrfToken = abp.security.antiForgery.getToken();
+        if (!csrfToken) {
+            return false;
+        }
+        var csrfCookieAuth = new SwaggerClient.ApiKeyAuthorization(abp.security.antiForgery.tokenHeaderName, csrfToken, 'header');
+        swaggerUi.api.clientAuthorizations.add(abp.security.antiForgery.tokenHeaderName, csrfCookieAuth);
+        return true;
+    }
+
+    abp.swagger.login = function () {
+        var tenantId = window.prompt('tenantId');
+        var usernameOrEmailAddress = window.prompt('usernameOrEmailAddress');
+        if (!usernameOrEmailAddress) {
+            return false;
+        }
+        var password = window.prompt('password');
+        var xhr = new XMLHttpRequest();
+        xhr.onreadystatechange = function () {
+            if (xhr.readyState === XMLHttpRequest.DONE && xhr.status === 200) {
+                var responseJSON = JSON.parse(xhr.responseText);
+                var result = responseJSON.result;
+                var expireDate = new Date(Date.now() + (result.expireInSeconds * 1000));
+                abp.auth.setToken(result.accessToken, expireDate);
+                abp.swagger.addAuthToken();
+                console.log(true);
+            }
+        };
+        xhr.open('POST', '/api/TokenAuth/Authenticate', true);
+        xhr.setRequestHeader('Abp.TenantId', tenantId);
+        xhr.setRequestHeader('Content-type', 'application/json');
+        xhr.send("{" +
+            "usernameOrEmailAddress:'" + usernameOrEmailAddress + "'," +
+            "password:'" + password + "'}"
+        );
+    }
+
+})();