Merge pull request #87 from snyk-labs/feat/add-oauth-support

Feat/add oauth support
snyk-labs · Dec 13, 2024 · eba2a2d · eba2a2d
2 parents 93e7ed8 + 3858dd5
commit eba2a2d
Show file tree

Hide file tree

Showing 3 changed files with 142 additions and 16 deletions.
diff --git a/src/lib/request/request.ts b/src/lib/request/request.ts
@@ -42,6 +42,7 @@ const getTopParentModuleName = (parent: NodeModule | null): string => {
 const makeSnykRequest = async (
   request: SnykRequest,
   snykToken = '',
+  oauthBearerToken = '',
   apiUrl = DEFAULT_API,
   apiUrlREST = DEFAULT_REST_API,
   userAgentPrefix = '',
@@ -57,20 +58,31 @@ const makeSnykRequest = async (
     userAgentPrefix != '' && !userAgentPrefix.endsWith('/')
       ? userAgentPrefix + '/'
       : userAgentPrefix;
+
+  // prioritize snykToken but use oauthBearerToken if snykToken isn't provided
+  const authorizationToken = snykToken
+    ? `token ${snykToken}`
+    : oauthBearerToken
+    ? `Bearer ${oauthBearerToken}`
+    : '';
+
   const requestHeaders: Record<string, any> = {
     'Content-Type':
       request.useRESTApi && request.body
         ? 'application/vnd.api+json'
         : 'application/json',
-    Authorization: 'token ' + snykToken,
+    Authorization: authorizationToken,
     'User-Agent': `${topParentModuleName}${userAgentPrefixChecked}tech-services/snyk-request-manager/1.0`,
   };
   let apiClient;
   if (proxyUri) {
     apiClient = axios.create({
       baseURL: request.useRESTApi ? apiUrlREST : apiUrl,
       responseType: 'json',
-      headers: { ...requestHeaders, ...request.headers },
+      headers: {
+        ...requestHeaders,
+        ...request.headers,
+      },
       transitional: {
         clarifyTimeoutError: true,
       },
@@ -81,7 +93,10 @@ const makeSnykRequest = async (
     apiClient = axios.create({
       baseURL: request.useRESTApi ? apiUrlREST : apiUrl,
       responseType: 'json',
-      headers: { ...requestHeaders, ...request.headers },
+      headers: {
+        ...requestHeaders,
+        ...request.headers,
+      },
       transitional: {
         clarifyTimeoutError: true,
       },

diff --git a/src/lib/request/requestManager.ts b/src/lib/request/requestManager.ts
@@ -46,6 +46,11 @@ function getRESTAPI(endpoint: string): string {
   return new URL(`${apiData.protocol}//${apiData.host}/rest`).toString();
 }
 
+function getOauthToken(): string {
+  const oauthToken: string = process.env.SNYK_OAUTH_TOKEN || '';
+  return oauthToken;
+}
+
 const getConfig = (): { endpoint: string; token: string } => {
   const snykApiEndpoint: string =
     process.env.SNYK_API ||
@@ -69,6 +74,7 @@ class RequestsManager {
   _retryCounter: Map<string, number>;
   _MAX_RETRY_COUNT: number;
   _snykToken: string;
+  _oauthBearerToken?: string; // Optional OAuth token
   _userAgentPrefix?: string;
 
   //snykToken = '', burstSize = 10, period = 500, maxRetryCount = 5
@@ -82,6 +88,7 @@ class RequestsManager {
     this._events = {};
     this._retryCounter = new Map();
     this._MAX_RETRY_COUNT = params?.maxRetryCount || 5;
+    this._oauthBearerToken = getOauthToken();
     this._snykToken = params?.snykToken ?? this._userConfig.token;
     this._apiUrl = this._userConfig.endpoint;
     this._apiUrlREST = getRESTAPI(this._userConfig.endpoint);
@@ -101,19 +108,41 @@ class RequestsManager {
   _makeRequest = async (request: QueuedRequest): Promise<void> => {
     const requestId = request.id;
     try {
-      const response = await makeSnykRequest(
-        request.snykRequest,
-        this._snykToken,
-        this._apiUrl,
-        this._apiUrlREST,
-        this._userAgentPrefix,
-      );
-      this._emit({
-        eventType: eventType.data,
-        channel: request.channel,
-        requestId,
-        data: response,
-      });
+      // Pass oauthBearerToken if available
+      if (
+        this._oauthBearerToken != null &&
+        this._oauthBearerToken.trim() != ''
+      ) {
+        const response = await makeSnykRequest(
+          request.snykRequest,
+          '',
+          this._oauthBearerToken,
+          this._apiUrl,
+          this._apiUrlREST,
+          this._userAgentPrefix,
+        );
+        this._emit({
+          eventType: eventType.data,
+          channel: request.channel,
+          requestId,
+          data: response,
+        });
+      } else {
+        const response = await makeSnykRequest(
+          request.snykRequest,
+          this._snykToken,
+          '',
+          this._apiUrl,
+          this._apiUrlREST,
+          this._userAgentPrefix,
+        );
+        this._emit({
+          eventType: eventType.data,
+          channel: request.channel,
+          requestId,
+          data: response,
+        });
+      }
     } catch (err) {
       const overloadedError = requestsManagerError.requestsManagerErrorOverload(
         err,

diff --git a/test/lib/request/request.test.ts b/test/lib/request/request.test.ts
@@ -229,3 +229,85 @@ describe('Test Snyk Utils error handling/classification', () => {
     }
   });
 });
+
+describe('Test makeSnykRequest with oauthBearerToken', () => {
+  beforeEach(() => {
+    nock.cleanAll();
+  });
+
+  afterEach(() => {
+    nock.cleanAll();
+  });
+
+  it('should set Bearer token in Authorization header when oauthBearerToken is provided for DEFAULT_API', async () => {
+    const testToken = 'test-oauth-token';
+    const request = {
+      verb: 'GET',
+      url: '/test-endpoint',
+    };
+
+    const scope = nock('https://api.snyk.io/v1')
+      .get('/test-endpoint')
+      .matchHeader('Authorization', `Bearer ${testToken}`)
+      .reply(200, { success: true });
+
+    await makeSnykRequest(request, '', testToken);
+
+    expect(scope.isDone()).toBe(true);
+  });
+
+  it('should set Bearer token in Authorization header when oauthBearerToken is provided for DEFAULT_REST_API', async () => {
+    const testToken = 'test-oauth-token';
+    const request = {
+      verb: 'GET',
+      url: '/test-endpoint',
+      useRESTApi: true,
+    };
+
+    const scope = nock('https://api.snyk.io/rest/')
+      .get('/test-endpoint')
+      .matchHeader('Authorization', `Bearer ${testToken}`)
+      .reply(200, { success: true });
+
+    await makeSnykRequest(request, '', testToken);
+
+    expect(scope.isDone()).toBe(true);
+  });
+
+  it('should prioritize snykToken over oauthBearerToken when both are provided for DEFAULT_API', async () => {
+    const snykToken = 'test-snyk-token';
+    const oauthToken = 'test-oauth-token';
+    const request = {
+      verb: 'GET',
+      url: '/test-endpoint',
+    };
+
+    const scope = nock('https://api.snyk.io/v1')
+      .get('/test-endpoint')
+      .matchHeader('Authorization', `token ${snykToken}`)
+      .reply(200, { success: true });
+
+    await makeSnykRequest(request, snykToken, oauthToken);
+
+    expect(scope.isDone()).toBe(true);
+  });
+
+  it('should prioritize snykToken over oauthBearerToken when both are provided for DEFAULT_REST_API', async () => {
+    const snykToken = 'test-snyk-token';
+    const oauthToken = 'test-oauth-token';
+    const request = {
+      verb: 'GET',
+      url: '/test-endpoint',
+      useRESTApi: true,
+    };
+
+    const scope = nock('https://api.snyk.io/rest/')
+      .get('/test-endpoint')
+      .matchHeader('Authorization', `token ${snykToken}`)
+      .reply(200, { success: true });
+
+    await makeSnykRequest(request, snykToken, oauthToken);
+
+    expect(scope.isDone()).toBe(true);
+  });
+});