Add new GitHub auth to v3 endpoint

eduardoboucas · Jan 13, 2019 · 4e2f33b · 4e2f33b
1 parent 2b10a1e
commit 4e2f33b
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 24 deletions.
diff --git a/config.js b/config.js
@@ -60,24 +60,30 @@ const schema = {
     default: 'https://github.com/login/oauth/access_token',
     env: 'GITHUB_ACCESS_TOKEN_URI'
   },
-  githubBaseUrl: {
-    doc: 'Base URL for the GitHub API.',
-    format: String,
-    default: 'https://api.github.com',
-    env: 'GITHUB_BASE_URL'
-  },
   githubAppID: {
     doc: 'ID of the GitHub App.',
     format: String,
     default: null,
     env: 'GITHUB_APP_ID'
   },
+  githubBaseUrl: {
+    doc: 'Base URL for the GitHub API.',
+    format: String,
+    default: 'https://api.github.com',
+    env: 'GITHUB_BASE_URL'
+  },
   githubPrivateKey: {
     doc: 'Private key for the GitHub App.',
     format: String,
     default: null,
     env: 'GITHUB_PRIVATE_KEY'
   },
+  githubToken: {
+    doc: 'Access token to the GitHub account (legacy)',
+    format: String,
+    default: null,
+    env: 'GITHUB_TOKEN'
+  },
   gitlabAccessTokenUri: {
     doc: 'URI for the GitLab authentication provider.',
     format: String,

diff --git a/config.test.json b/config.test.json
@@ -2,6 +2,7 @@
   "gitlabToken": "r4e3w2q1",
   "githubToken": "1q2w3e4r",
   "rsaPrivateKey": "-----BEGIN RSA PRIVATE KEY-----MIIEpAIBAAKCAQEA2nX81/5w6nZLolEh0uKks3//FlqizKxFWi8GaEJYbud8FYwLH6l+LDfZkjQiDXvm6mxngDGCjlG9b7hgfa/sfWSuqtJUQ2D1Nenn11gwAUaI7OQNSassE+nVFL2BGedl6DOgpZFkKrDTQT7jyvvc3r/2IqWahAYyFWXImD50qwNWIGyZ2Sry2/WXeCydiUWV8ZG3GOlGZLgtlK8igdmLje/6Ja+1oRBFwdbWrf/nKsMB0fCL3R5MkWTnumR8sGx2Xud8Q3mF7cOYWQiy2AqrFQOzJ+QwH6hO6CGVk8eBh8xRkrjaZEsvolZ33N+0aS9NBxHuOyGq0Te9HMLFqwVGzwIDAQABAoIBAQDPD4gAnb0erdMQXT/m50TekdIQuQWXYy00xl+XUFMLg0L8FUmxz++0L5d72Qfxqd97kBYlzkeFZ3pbOvHSD33ieByJ8mNFnc+tMy+4z3BotRcxGRJzIdfcZAS/7MJB8C6KAO0iIQVE5WbGb7pu+XwmcOH1gutKeajc2SVhD8l7ECRARPuV3JxlhbVt+ylM05h7+5HwwnEmodNQHPeGvLEWp7eODNdcLLE5EFVjmN0dwGu9D+xCFna9bL7p921GOTGf349l3021ONaGvWd77Frhl9tHL1k40hqq4LiXDk3RkiP2oDb65+ohW128Q1QPgjMQuXbbFTCa3++pbz7OMbUhAoGBAPxt6A5B3s5GnnaCTE0YJ13aTeUyqrLimBxWEp7L/WXug8SDBW5tVAmBNHlZC4GuR089E7g26BVr0i3k/dOknKa0GLyGGJNphxrrcD05p+XB6Gd6/N1Yr6amM+8XqU1+UKLL2CBrLOSi6r4J4fPS8sb9362+FROwCJZfxd5Wznd/AoGBAN2NEz+anDBgulxLoguGuvc0FaqSsVIP/cdb5Ve5t29/uheVjLgDXSkV5P/RFfk1ygH1gNjmUrsoxfsGWQa3KMTk292maYRj7GPpOalSlp8BYyiQ9omPdOgusVzY4CEjMiDkKal0YrBswXKV8E2lTokEEkbdrQpToVdBmRCzT1ixAoGBAMNMBQ2CyO6ulEr75CyBU3O5QirhWE+uICFMNnvFNvd14VxYQgt9alcwL3jy+4QJYgJcLrWHRWfNU39Oe1MTOF+BVuIEnV7vdifNn7i+srd/nl7xOFHIG53DWMrSc5oQ8DIDo+LxCHqb0SHWY4pQ2qQ6JqQ1O/lPaFVvI5cxcevhAoGALyNtDQNgaAqsnCabe8hWz3INihVcFRHB9UDgMyIYnWiXt5ziK+TLVYqLBsL94eBH8tLBb2TSBXBPb3GST5N44SuwfCCEIt7/1OIymowv7/TjnCX7zpjvTtdgdVjPlz1d1RG2q49P0CnTnwW3801QwGZVXS6dOq1AjsguQRdlsoECgYBrFqKa3S48UbGOKkocgMb/1HzVs2sxNWMu+/jEiBvI4RrCiun9MALtrVtohgHRml4yZJaOojVk9F0z/MAak9eTgSmHpwxYZMqR1PvM4c/ekfun4hQoK04Thoexi/Z0RfsI6nBdBk8MAra03ldDvnYZY4Fat21YuNBspbrbTW8UoA==-----END RSA PRIVATE KEY-----",
+  "githubPrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA2nX81/5w6nZLolEh0uKks3//FlqizKxFWi8GaEJYbud8FYwLH6l+LDfZkjQiDXvm6mxngDGCjlG9b7hgfa/sfWSuqtJUQ2D1Nenn11gwAUaI7OQNSassE+nVFL2BGedl6DOgpZFkKrDTQT7jyvvc3r/2IqWahAYyFWXImD50qwNWIGyZ2Sry2/WXeCydiUWV8ZG3GOlGZLgtlK8igdmLje/6Ja+1oRBFwdbWrf/nKsMB0fCL3R5MkWTnumR8sGx2Xud8Q3mF7cOYWQiy2AqrFQOzJ+QwH6hO6CGVk8eBh8xRkrjaZEsvolZ33N+0aS9NBxHuOyGq0Te9HMLFqwVGzwIDAQABAoIBAQDPD4gAnb0erdMQXT/m50TekdIQuQWXYy00xl+XUFMLg0L8FUmxz++0L5d72Qfxqd97kBYlzkeFZ3pbOvHSD33ieByJ8mNFnc+tMy+4z3BotRcxGRJzIdfcZAS/7MJB8C6KAO0iIQVE5WbGb7pu+XwmcOH1gutKeajc2SVhD8l7ECRARPuV3JxlhbVt+ylM05h7+5HwwnEmodNQHPeGvLEWp7eODNdcLLE5EFVjmN0dwGu9D+xCFna9bL7p921GOTGf349l3021ONaGvWd77Frhl9tHL1k40hqq4LiXDk3RkiP2oDb65+ohW128Q1QPgjMQuXbbFTCa3++pbz7OMbUhAoGBAPxt6A5B3s5GnnaCTE0YJ13aTeUyqrLimBxWEp7L/WXug8SDBW5tVAmBNHlZC4GuR089E7g26BVr0i3k/dOknKa0GLyGGJNphxrrcD05p+XB6Gd6/N1Yr6amM+8XqU1+UKLL2CBrLOSi6r4J4fPS8sb9362+FROwCJZfxd5Wznd/AoGBAN2NEz+anDBgulxLoguGuvc0FaqSsVIP/cdb5Ve5t29/uheVjLgDXSkV5P/RFfk1ygH1gNjmUrsoxfsGWQa3KMTk292maYRj7GPpOalSlp8BYyiQ9omPdOgusVzY4CEjMiDkKal0YrBswXKV8E2lTokEEkbdrQpToVdBmRCzT1ixAoGBAMNMBQ2CyO6ulEr75CyBU3O5QirhWE+uICFMNnvFNvd14VxYQgt9alcwL3jy+4QJYgJcLrWHRWfNU39Oe1MTOF+BVuIEnV7vdifNn7i+srd/nl7xOFHIG53DWMrSc5oQ8DIDo+LxCHqb0SHWY4pQ2qQ6JqQ1O/lPaFVvI5cxcevhAoGALyNtDQNgaAqsnCabe8hWz3INihVcFRHB9UDgMyIYnWiXt5ziK+TLVYqLBsL94eBH8tLBb2TSBXBPb3GST5N44SuwfCCEIt7/1OIymowv7/TjnCX7zpjvTtdgdVjPlz1d1RG2q49P0CnTnwW3801QwGZVXS6dOq1AjsguQRdlsoECgYBrFqKa3S48UbGOKkocgMb/1HzVs2sxNWMu+/jEiBvI4RrCiun9MALtrVtohgHRml4yZJaOojVk9F0z/MAak9eTgSmHpwxYZMqR1PvM4c/ekfun4hQoK04Thoexi/Z0RfsI6nBdBk8MAra03ldDvnYZY4Fat21YuNBspbrbTW8UoA==\n-----END RSA PRIVATE KEY-----",
   "email": {
     "apiKey": "key-1q2w3e4r"
   },

diff --git a/controllers/auth.js b/controllers/auth.js
@@ -35,7 +35,8 @@ module.exports = (req, res) => {
     .then(requestAccessToken)
     .then((accessToken) => {
       const git = gitFactory.create(req.params.service, {
-        oauthToken: accessToken
+        oauthToken: accessToken,
+        version: req.params.version
       })
 
       // TODO: Simplify this when v2 support is dropped.

diff --git a/lib/GitHub.js b/lib/GitHub.js
@@ -23,12 +23,24 @@ class GitHub extends GitService {
       timeout: 5000
     })
 
+    const isAppAuth = config.get('githubAppID') &&
+      config.get('githubPrivateKey')
+    const isLegacyAuth = config.get('githubToken') &&
+      ['1', '2'].includes(options.version)
+
+    this.authentication = Promise.resolve()
+
     if (options.oauthToken) {
       this.api.authenticate({
         type: 'oauth',
         token: options.oauthToken
       })
-    } else if (options.token) {
+    } else if (isLegacyAuth) {
+      this.api.authenticate({
+        type: 'token',
+        token: config.get('githubToken')
+      })
+    } else if (isAppAuth) {
       this.authentication = this._authenticate(
         options.username,
         options.repository

diff --git a/lib/GitLab.js b/lib/GitLab.js
@@ -11,15 +11,17 @@ class GitLab extends GitService {
   constructor (options = {}) {
     super(options.username, options.repository, options.branch)
 
+    const token = config.get('gitlabToken')
+
     if (options.oauthToken) {
       this.api = new GitLabApi({
         url: config.get('gitlabBaseUrl'),
         oauthToken: options.oauthToken
       })
-    } else if (options.token) {
+    } else if (token) {
       this.api = new GitLabApi({
         url: config.get('gitlabBaseUrl'),
-        token: options.token
+        token
       })
     } else {
       throw new Error('Require an `oauthToken` or `token` option')

diff --git a/lib/Staticman.js b/lib/Staticman.js
@@ -20,20 +20,21 @@ const yaml = require('js-yaml')
 const Staticman = function (parameters) {
   this.parameters = parameters
 
-  const token = parameters.service === 'gitlab'
-    ? config.get('gitlabToken')
-    : {
-      integrationId: config.get('githubAppID'),
-      privateKey: config.get('githubPrivateKey')
-    }
+  const {
+    branch,
+    repository,
+    service,
+    username,
+    version
+  } = parameters
 
   // Initialise the Git service API
-  this.git = gitFactory.create(parameters.service, {
-    username: parameters.username,
-    repository: parameters.repository,
-    branch: parameters.branch,
-    token
-  })
+  this.git = gitFactory.create(service, {
+    branch,
+    repository,
+    username,
+    version
+  })  
 
   // Generate unique id
   this.uid = uuidv1()
@@ -176,7 +177,10 @@ Staticman.prototype._checkAuth = function () {
     return Promise.reject(errorHandler('AUTH_TOKEN_INVALID'))
   }
 
-  const git = gitFactory.create(this.options['auth-type'], {oauthToken})
+  const git = gitFactory.create(this.options['auth-type'], {
+    oauthToken,
+    version: this.parameters.version
+  })
 
   return git.getCurrentUser().then(user => {
     this.gitUser = user
@@ -201,7 +205,10 @@ Staticman.prototype._checkAuthV2 = function () {
     return Promise.reject(errorHandler('GITHUB_AUTH_TOKEN_INVALID'))
   }
 
-  const git = gitFactory.create('github', {oauthToken})
+  const git = gitFactory.create('github', {
+    oauthToken,
+    version: this.parameters.version
+  })
 
   return git.api.users.getAuthenticated({}).then(({data}) => {
     this.gitUser = data
@@ -497,6 +504,8 @@ Staticman.prototype.processEntry = function (fields, options) {
   this.fields = Object.assign({}, fields)
   this.options = Object.assign({}, options)
 
+  this._initialiseGit
+
   return this.getSiteConfig().then(config => {
     return this._checkAuth()
   }).then(() => {