From 522effaaf0e3ba06c30184aac4afe60ae9f04850 Mon Sep 17 00:00:00 2001 From: Nikitha Chettiar Date: Mon, 13 Jun 2022 23:05:22 -0700 Subject: [PATCH] adding kiota the msal browser package --- .../authentication/msal-browser/.eslintignore | 7 + .../msal-browser/.eslintrc.json | 237 ++++++++++++++++++ .../authentication/msal-browser/.gitignore | 2 + .../authentication/msal-browser/package.json | 45 ++++ .../src/msalBrowserAccessTokenProvider.ts | 96 +++++++ .../src/msalBrowserAuthenticationConfig.ts | 12 + .../src/msalBrowserAuthenticationProvider.ts | 23 ++ .../msal-browser/tsconfig.base.json | 21 ++ .../msal-browser/tsconfig.cjs.json | 15 ++ .../msal-browser/tsconfig.es.json | 15 ++ yarn.lock | 14 +- 11 files changed, 486 insertions(+), 1 deletion(-) create mode 100644 packages/authentication/msal-browser/.eslintignore create mode 100644 packages/authentication/msal-browser/.eslintrc.json create mode 100644 packages/authentication/msal-browser/.gitignore create mode 100644 packages/authentication/msal-browser/package.json create mode 100644 packages/authentication/msal-browser/src/msalBrowserAccessTokenProvider.ts create mode 100644 packages/authentication/msal-browser/src/msalBrowserAuthenticationConfig.ts create mode 100644 packages/authentication/msal-browser/src/msalBrowserAuthenticationProvider.ts create mode 100644 packages/authentication/msal-browser/tsconfig.base.json create mode 100644 packages/authentication/msal-browser/tsconfig.cjs.json create mode 100644 packages/authentication/msal-browser/tsconfig.es.json diff --git a/packages/authentication/msal-browser/.eslintignore b/packages/authentication/msal-browser/.eslintignore new file mode 100644 index 000000000..8942aa232 --- /dev/null +++ b/packages/authentication/msal-browser/.eslintignore @@ -0,0 +1,7 @@ +*.js +*.js.map +*.d.ts + +node_modules +lib +spec/development \ No newline at end of file diff --git a/packages/authentication/msal-browser/.eslintrc.json b/packages/authentication/msal-browser/.eslintrc.json new file mode 100644 index 000000000..e73e74ab4 --- /dev/null +++ b/packages/authentication/msal-browser/.eslintrc.json @@ -0,0 +1,237 @@ +{ + "root": true, + "parser": "@typescript-eslint/parser", + "plugins": [ + "@typescript-eslint", + "prettier", + "simple-import-sort" + ], + "extends": [ + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", + "plugin:@typescript-eslint/recommended", + "prettier" + ], + "rules": { + "@typescript-eslint/no-empty-interface": "warn", + "@typescript-eslint/ban-types": "off", + "@typescript-eslint/no-unused-vars": "error", + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/explicit-module-boundary-types": "off", + "prettier/prettier": [ + "error", + { + "endOfLine": "auto" + } + ], + "@typescript-eslint/no-var-requires": "error", + "@typescript-eslint/no-non-null-assertion": "error", + "@typescript-eslint/naming-convention": [ + "error", + { + "selector": "typeLike", + "format": [ + "PascalCase" + ], + "filter": { + "regex": "^(__String|[A-Za-z]+_[A-Za-z]+)$", + "match": false + } + }, + { + "selector": "interface", + "format": [ + "PascalCase" + ], + "custom": { + "regex": "^I[A-Z]", + "match": false + }, + "filter": { + "regex": "^I(Arguments|TextWriter|O([A-Z][a-z]+[A-Za-z]*)?)$", + "match": false + } + }, + { + "selector": "variable", + "format": [ + "camelCase", + "PascalCase", + "UPPER_CASE" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^(_{1,2}filename|_{1,2}dirname|_+|[A-Za-z]+_[A-Za-z]+)$", + "match": false + } + }, + { + "selector": "function", + "format": [ + "camelCase", + "PascalCase" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^[A-Za-z]+_[A-Za-z]+$", + "match": false + } + }, + { + "selector": "parameter", + "format": [ + "camelCase" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^(_+|[A-Za-z]+_[A-Z][a-z]+)$", + "match": false + } + }, + { + "selector": "method", + "format": [ + "camelCase", + "PascalCase" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^[A-Za-z]+_[A-Za-z]+$", + "match": false + } + }, + { + "selector": "memberLike", + "format": [ + "camelCase" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^[A-Za-z]+_[A-Za-z]+$", + "match": false + } + }, + { + "selector": "enumMember", + "format": [ + "camelCase", + "PascalCase" + ], + "leadingUnderscore": "allow", + "filter": { + "regex": "^[A-Za-z]+_[A-Za-z]+$", + "match": false + } + }, + { + "selector": "property", + "format": null + } + ], + "@typescript-eslint/semi": "error", + "@typescript-eslint/no-use-before-define": "off", + "@typescript-eslint/prefer-for-of": "error", + "@typescript-eslint/prefer-function-type": "error", + "@typescript-eslint/prefer-namespace-keyword": "error", + "@typescript-eslint/quotes": [ + "error", + "double", + { + "avoidEscape": true, + "allowTemplateLiterals": true + } + ], + "@typescript-eslint/space-within-parens": [ + "off", + "never" + ], + "@typescript-eslint/triple-slash-reference": "error", + "@typescript-eslint/type-annotation-spacing": "error", + "@typescript-eslint/unified-signatures": "error", + "@typescript-eslint/adjacent-overload-signatures": "error", + "@typescript-eslint/array-type": "error", + "@typescript-eslint/consistent-type-definitions": [ + "error", + "interface" + ], + "@typescript-eslint/no-inferrable-types": "error", + "@typescript-eslint/no-misused-new": "error", + "@typescript-eslint/no-this-alias": "error", + "no-unused-expressions": "off", + "@typescript-eslint/no-unused-expressions": [ + "error", + { + "allowTernary": true + } + ], + "@typescript-eslint/space-before-function-paren": "off", + "@typescript-eslint/consistent-type-assertions": "error", + "@typescript-eslint/explicit-member-accessibility": [ + "off", + { + "accessibility": "explicit" + } + ], + "@typescript-eslint/indent": "off", + "@typescript-eslint/interface-name-prefix": "off", + "@typescript-eslint/member-delimiter-style": [ + "off", + { + "multiline": { + "delimiter": "none", + "requireLast": true + }, + "singleline": { + "delimiter": "semi", + "requireLast": false + } + } + ], + "@typescript-eslint/member-ordering": "off", + "@typescript-eslint/no-empty-function": "error", + "@typescript-eslint/no-namespace": "off", + "@typescript-eslint/no-parameter-properties": "off", + "@typescript-eslint/no-array-constructor": "error", + "no-useless-catch": "error", + "prefer-rest-params": "off", + "no-constant-condition": "error", + "simple-import-sort/imports": "error", + "brace-style": "error", + "constructor-super": "error", + "curly": [ + "error", + "multi-line" + ], + "dot-notation": "off", + "eqeqeq": "error", + "new-parens": "error", + "no-caller": "error", + "no-duplicate-case": "error", + "no-duplicate-imports": "error", + "no-empty": "error", + "no-eval": "error", + "no-extra-bind": "error", + "no-fallthrough": "error", + "no-new-func": "off", + "no-new-wrappers": "error", + "no-return-await": "off", + "no-sparse-arrays": "error", + "no-template-curly-in-string": "error", + "no-throw-literal": "error", + "no-trailing-spaces": "error", + "no-undef-init": "error", + "no-unsafe-finally": "error", + "no-unused-labels": "error", + "no-var": "error", + "object-shorthand": "error", + "prefer-const": "error", + "prefer-object-spread": "error", + "quote-props": "off", + "space-in-parens": "error", + "unicode-bom": [ + "error", + "never" + ], + "use-isnan": "error" + } +} \ No newline at end of file diff --git a/packages/authentication/msal-browser/.gitignore b/packages/authentication/msal-browser/.gitignore new file mode 100644 index 000000000..75f7ba5bd --- /dev/null +++ b/packages/authentication/msal-browser/.gitignore @@ -0,0 +1,2 @@ +dist +*.tsbuildinfo \ No newline at end of file diff --git a/packages/authentication/msal-browser/package.json b/packages/authentication/msal-browser/package.json new file mode 100644 index 000000000..baf33894b --- /dev/null +++ b/packages/authentication/msal-browser/package.json @@ -0,0 +1,45 @@ +{ + "name": "@microsoft/kiota-authentication-msal-browser", + "version": "1.0.0-preview.1", + "description": "Authentication provider for Kiota using MSAL browser", + "main": "dist/cjs/src/index.js", + "module": "dist/es/src/index.js", + "types": "dist/cjs/src/index.d.ts", + "files": [ + "src", + "dist" + ], + "scripts": { + "build": "npm run build:cjs && npm run build:esm", + "build:cjs": "tsc -b tsconfig.cjs.json", + "build:esm": "tsc -b tsconfig.es.json", + "test:cjs": "npm run build:cjs && mocha 'dist/cjs/test/**/*.js'", + "test:es": " npm run build:esm && mocha 'dist/es/test/**/*.js' --require esm", + "test": "npm run test:cjs && npm run test:es", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "clean": "rm -r ./dist" + }, + "repository": "git://github.com/microsoft/kiota-typescript.git", + "keywords": [ + "Kiota", + "OpenApi", + "MSAL", + "Authentication", + "Browser" + ], + "author": "Microsoft", + "license": "MIT", + "bugs": { + "url": "https://github.com/microsoft/kiota-typescript/issues" + }, + "homepage": "https://github.com/microsoft/kiota-typescript#readme", + "dependencies": { + "@azure/msal-browser": "^2.26.0", + "@microsoft/kiota-abstractions": "1.0.0-preview.6", + "tslib": "^2.3.1" + }, + "devDependencies": { + "@types/mocha": "^9.1.1" + } +} diff --git a/packages/authentication/msal-browser/src/msalBrowserAccessTokenProvider.ts b/packages/authentication/msal-browser/src/msalBrowserAccessTokenProvider.ts new file mode 100644 index 000000000..b41aa25d1 --- /dev/null +++ b/packages/authentication/msal-browser/src/msalBrowserAccessTokenProvider.ts @@ -0,0 +1,96 @@ +import { + AuthenticationResult, + InteractionRequiredAuthError, + InteractionType, +} from "@azure/msal-browser"; +import { + AccessTokenProvider, + AllowedHostsValidator, + validateProtocol, +} from "@microsoft/kiota-abstractions"; + +import { MSALBrowserAuthenticationConfig } from "./msalBrowserAuthenticationConfig"; + +/** Access token provider that leverages the MSALBrowser Identity library to retrieve an access token. */ +export class MSALBrowserAccessTokenProvder implements AccessTokenProvider { + /** + *@param msalBrowserAuthenticationConfig The MSALBrowser public client application, scopes, account type and interaction type to use for authentication. + *@param allowedHosts The allowed hosts to use for authentication. + */ + public constructor( + private msalBrowserAuthenticationConfig: MSALBrowserAuthenticationConfig, + allowedHosts: Set + ) { + if (!msalBrowserAuthenticationConfig) { + throw new Error( + "Please pass valid PublicClientApplication instance, AccountInfo, Scopes and InteractionType" + ); + } + this.allowedHostsValidator = new AllowedHostsValidator(allowedHosts); + } + private readonly allowedHostsValidator: AllowedHostsValidator; + + /** + * @inheritdoc + */ + public async getAuthorizationToken(url?: string): Promise { + if (!url || !this.allowedHostsValidator.isUrlHostValid(url)) { + return ""; + } + validateProtocol(url); + + const scopes = + this.msalBrowserAuthenticationConfig && + this.msalBrowserAuthenticationConfig.scopes; + const account = + this.msalBrowserAuthenticationConfig && + this.msalBrowserAuthenticationConfig.account; + const error = new Error(); + if (!scopes || scopes.length === 0) { + error.name = "Empty Scopes"; + error.message = "Scopes cannot be empty, Please provide scopes"; + throw error; + } + try { + const response: AuthenticationResult = + await this.msalBrowserAuthenticationConfig.publicClientApplication.acquireTokenSilent( + { + scopes, + account, + } + ); + if (!response || !response.accessToken) { + error.name = "Access token is undefined"; + error.message = + "Received empty access token from PublicClientApplication"; + throw error; + } + return response.accessToken; + } catch (error) { + if (error instanceof InteractionRequiredAuthError) { + if ( + this.msalBrowserAuthenticationConfig.interactionType === + InteractionType.Redirect + ) { + this.msalBrowserAuthenticationConfig.publicClientApplication.acquireTokenRedirect( + { scopes } + ); + } else if ( + this.msalBrowserAuthenticationConfig.interactionType === + InteractionType.Popup + ) { + const response: AuthenticationResult = + await this.msalBrowserAuthenticationConfig.publicClientApplication.acquireTokenPopup( + { scopes } + ); + return response.accessToken; + } + } + throw error; + } + } + /** + * @inheritdoc + */ + public getAllowedHostsValidator = () => this.allowedHostsValidator; +} diff --git a/packages/authentication/msal-browser/src/msalBrowserAuthenticationConfig.ts b/packages/authentication/msal-browser/src/msalBrowserAuthenticationConfig.ts new file mode 100644 index 000000000..54e8355c6 --- /dev/null +++ b/packages/authentication/msal-browser/src/msalBrowserAuthenticationConfig.ts @@ -0,0 +1,12 @@ +import { + AccountInfo, + InteractionType, + PublicClientApplication, +} from "@azure/msal-browser"; + +export interface MSALBrowserAuthenticationConfig { + publicClientApplication: PublicClientApplication; + account: AccountInfo; + interactionType: InteractionType; + readonly scopes: string[]; +} diff --git a/packages/authentication/msal-browser/src/msalBrowserAuthenticationProvider.ts b/packages/authentication/msal-browser/src/msalBrowserAuthenticationProvider.ts new file mode 100644 index 000000000..790fb7161 --- /dev/null +++ b/packages/authentication/msal-browser/src/msalBrowserAuthenticationProvider.ts @@ -0,0 +1,23 @@ +import { BaseBearerTokenAuthenticationProvider } from "@microsoft/kiota-abstractions"; + +import { MSALBrowserAccessTokenProvder } from "./msalBrowserAccessTokenProvider"; +import { MSALBrowserAuthenticationConfig } from "./msalBrowserAuthenticationConfig"; + +export class MSALBrowserAuthenticationProvider extends BaseBearerTokenAuthenticationProvider { + /** + *@constructor + *@param msalBrowserAuthenticationConfig The MSALBrowser public client application, scopes, account type and interaction type to use for authentication. + *@param allowedHosts The allowed hosts to use for authentication. + */ + public constructor( + msalBrowserAuthenticationConfig: MSALBrowserAuthenticationConfig, + allowedHosts: Set + ) { + super( + new MSALBrowserAccessTokenProvder( + msalBrowserAuthenticationConfig, + allowedHosts + ) + ); + } +} diff --git a/packages/authentication/msal-browser/tsconfig.base.json b/packages/authentication/msal-browser/tsconfig.base.json new file mode 100644 index 000000000..18512f53d --- /dev/null +++ b/packages/authentication/msal-browser/tsconfig.base.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "importHelpers": true, + "noEmitOnError": true, + "moduleResolution": "node", + "strict": true, + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "forceConsistentCasingInFileNames": true, + "declaration": true, + "declarationMap": true, + "composite": true, + "paths": { + "@microsoft/kiota-abstractions": [ + "../../abstractions" + ], + } + } +} \ No newline at end of file diff --git a/packages/authentication/msal-browser/tsconfig.cjs.json b/packages/authentication/msal-browser/tsconfig.cjs.json new file mode 100644 index 000000000..2c38a55da --- /dev/null +++ b/packages/authentication/msal-browser/tsconfig.cjs.json @@ -0,0 +1,15 @@ +{ + "extends": "./tsconfig.base.json", + "compilerOptions":{ + "target": "ES2015", + "module": "commonjs", + "outDir": "./dist/cjs" + }, + "exclude": ["node_modules", "dist"], + "include": ["./src/**/*.ts", "./test"], + "references": [ + { + "path": "../../abstractions/tsconfig.cjs.json" + }, + ] +} \ No newline at end of file diff --git a/packages/authentication/msal-browser/tsconfig.es.json b/packages/authentication/msal-browser/tsconfig.es.json new file mode 100644 index 000000000..01f26ef4b --- /dev/null +++ b/packages/authentication/msal-browser/tsconfig.es.json @@ -0,0 +1,15 @@ +{ + "extends": "./tsconfig.base.json", + "compilerOptions": { + "module": "ES2015", + "target": "ES2017", + "outDir": "dist/es/" + }, + "exclude": ["node_modules", "dist"], + "include": ["./src/**/*.ts", "./test/**/*.ts"], + "references": [ + { + "path": "../../abstractions/tsconfig.es.json" + }, + ] +} diff --git a/yarn.lock b/yarn.lock index 9a143531b..ce649bc71 100644 --- a/yarn.lock +++ b/yarn.lock @@ -108,6 +108,13 @@ dependencies: "@azure/msal-common" "^6.1.0" +"@azure/msal-browser@^2.26.0": + version "2.26.0" + resolved "https://registry.yarnpkg.com/@azure/msal-browser/-/msal-browser-2.26.0.tgz#32d0c4cfe29a34030fd22106697a2d866893ac87" + integrity sha512-mSyZORSgeMEWz5Wo5alUqjxP/HKt/XcViZqc3dnKFM9347qYPIWsAlzHkEmmafNr1VGUo7MeqB0emZCOQrl04w== + dependencies: + "@azure/msal-common" "^7.0.0" + "@azure/msal-common@^4.5.1": version "4.5.1" resolved "https://registry.yarnpkg.com/@azure/msal-common/-/msal-common-4.5.1.tgz#f35af8b634ae24aebd0906deb237c0db1afa5826" @@ -122,6 +129,11 @@ dependencies: debug "^4.1.1" +"@azure/msal-common@^7.0.0": + version "7.0.0" + resolved "https://registry.yarnpkg.com/@azure/msal-common/-/msal-common-7.0.0.tgz#f4b52c6d9591cf8720dcb24c1d21fce2d186f871" + integrity sha512-EkaHGjv0kw1RljhboeffM91b+v9d5VtmyG+0a/gvdqjbLu3kDzEfoaS5BNM9QqMzbxgZylsjAjQDtxdHLX/ziA== + "@azure/msal-node@^1.3.0": version "1.7.0" resolved "https://registry.yarnpkg.com/@azure/msal-node/-/msal-node-1.7.0.tgz#9026971b1fd953f15bfddde9c43e180356a80d77" @@ -1477,7 +1489,7 @@ resolved "https://registry.yarnpkg.com/@types/minimist/-/minimist-1.2.2.tgz#ee771e2ba4b3dc5b372935d549fd9617bf345b8c" integrity sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ== -"@types/mocha@^9.1.0": +"@types/mocha@^9.1.0", "@types/mocha@^9.1.1": version "9.1.1" resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-9.1.1.tgz#e7c4f1001eefa4b8afbd1eee27a237fee3bf29c4" integrity sha512-Z61JK7DKDtdKTWwLeElSEBcWGRLY8g95ic5FoQqI9CMx0ns/Ghep3B4DfcEimiKMvtamNVULVNKEsiwV3aQmXw==