OAuth1 support (MrRefactoring#89)

Author: jayree

README.md

@@ -111,6 +111,22 @@ const client = new Client({
 });
 ```
 
+### OAuth1.0 authentication
+
+```js
+const client = new Client({
+  host: "https://jira.somehost.com",
+  authentication: {
+    oauth1: {
+      consumerKey: "your consumer key",
+      consumerSecret: "-----BEGIN RSA PRIVATE KEY-----\n" + "some private key\n" + "-----END RSA PRIVATE KEY-----",
+      accessToken: "your access token",
+      tokenSecret: "your token secret"
+    }
+  }
+});
+```
+
 ### OAuth2.0 authentication
 
 ```js

package.json

@@ -29,6 +29,7 @@
     "@types/express": "^4.17.8",
     "@types/jest": "^26.0.15",
     "@types/node": "^14.14.5",
+    "@types/oauth": "^0.9.1",
     "@types/sinon": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^4.6.0",
     "@typescript-eslint/parser": "^4.6.0",
@@ -44,6 +45,7 @@
   },
   "dependencies": {
     "atlassian-jwt": "^1.0.3",
-    "axios": "^0.21.0"
+    "axios": "^0.21.0",
+    "oauth": "^0.9.15"
   }
 }

src/config.ts

@@ -17,6 +17,7 @@ export namespace Config {
     jwt?: Authentication.JWT;
     accessToken?: Authentication.AccessToken;
     basic?: Authentication.Basic;
+    oauth1?: Authentication.OAuth1;
   }
 
   export interface Middlewares {
@@ -42,6 +43,13 @@ export namespace Config {
       password?: string;
     };
 
+    export type OAuth1 = {
+      consumerKey: string;
+      consumerSecret: string;
+      accessToken: string;
+      tokenSecret: string;
+    };
+
     export type AccessToken = string;
   }
 }

src/helpers/index.ts

@@ -1,6 +1,7 @@
 import { AxiosRequestConfig } from 'axios';
 import * as jwt from 'atlassian-jwt';
 import * as url from 'url';
+import { OAuth } from 'oauth';
 import { Config } from '../config';
 
 export const getAuthentication = (
@@ -30,6 +31,26 @@ export const getAuthentication = (
     return `JWT ${jwtToken}`;
   }
 
+  if (config.authentication?.oauth1) {
+    const oauthUrl = `${config.host}/plugins/servlet/oauth/`;
+    const oauth = new OAuth(
+      `${oauthUrl}request-token`,
+      `${oauthUrl}access-token`,
+      config.authentication.oauth1.consumerKey,
+      config.authentication.oauth1.consumerSecret,
+      '1.0',
+      null,
+      'RSA-SHA1',
+    );
+
+    return oauth.authHeader(
+      url.resolve(config.host, request.url!),
+      config.authentication.oauth1.accessToken,
+      config.authentication.oauth1.tokenSecret,
+      request.method!,
+    );
+  }
+
   if (config.authentication?.accessToken) {
     return `Bearer ${config.authentication.accessToken}`;
   }

src/index.ts

@@ -293,7 +293,8 @@ export class Client {
   public async sendRequest(request: AxiosRequestConfig, callback?: Callback): Promise<any> {
     try {
       request.headers = Utils.removeUndefinedElements({
-        Authorization: getAuthentication(this.config, request),
+        Authorization: getAuthentication(this.config,
+          { ...request, url: this.requestInstance.getUri(request) }),
         ...request.headers,
       });
 

yarn.lock

@@ -667,6 +667,13 @@
   resolved "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz"
   integrity sha512-f5j5b/Gf71L+dbqxIpQ4Z2WlmI/mPJ0fOkGGmFgtb6sAu97EPczzbS3/tJKxmcYDj55OX6ssqwDAWOHIYDRDGA==
 
+"@types/oauth@^0.9.1":
+  version "0.9.1"
+  resolved "https://registry.yarnpkg.com/@types/oauth/-/oauth-0.9.1.tgz#e17221e7f7936b0459ae7d006255dff61adca305"
+  integrity sha512-a1iY62/a3yhZ7qH7cNUsxoI3U/0Fe9+RnuFrpTKr+0WVOzbKlSLojShCKe20aOD1Sppv+i8Zlq0pLDuTJnwS4A==
+  dependencies:
+    "@types/node" "*"
+
 "@types/prettier@^2.0.0":
   version "2.1.1"
   resolved "https://registry.npmjs.org/@types/prettier/-/prettier-2.1.1.tgz"
@@ -3467,6 +3474,11 @@ oauth-sign@~0.9.0:
   resolved "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz"
   integrity sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==
 
+oauth@^0.9.15:
+  version "0.9.15"
+  resolved "https://registry.yarnpkg.com/oauth/-/oauth-0.9.15.tgz#bd1fefaf686c96b75475aed5196412ff60cfb9c1"
+  integrity sha1-vR/vr2hslrdUda7VGWQS/2DPucE=
+
 object-copy@^0.1.0:
   version "0.1.0"
   resolved "https://registry.npmjs.org/object-copy/-/object-copy-0.1.0.tgz"