[WIP] Authentication context (resolves #94)

example/index.js

@@ -24,20 +24,19 @@ const port = process.env.PORT || 7005;
 
 const repos = new Server(path.normalize(path.resolve(__dirname, 'tmp')), {
   autoCreate: true,
-  authenticate: ({ type, repo, user, headers }, next) => {
+  authenticate: async ({ type, repo, getUser, headers }) => {
     console.log(type, repo, headers); // eslint-disable-line
     if (type == 'push') {
+      const [username, password] = await getUser();
       // Decide if this user is allowed to perform this action against this repo.
-      user((username, password) => {
-        if (username === '42' && password === '42') {
-          next();
-        } else {
-          next('wrong password');
-        }
-      });
-    } else {
-      // Check these credentials are correct for this user.
-      next();
+      if (username === '42' && password === '42') {
+        // This return value can be whatever you want - it is accessible from events.
+        return {
+          protectedBranches: ["docs", "main"],
+        };
+      } else {
+        throw Error('wrong password');
+      }
     }
   },
 });
@@ -55,7 +54,12 @@ repos.on('push', (push) => {
     push.log(' ');
   });
 
-  push.accept();
+  if (push.context.protectedBranches.indexOf(push.branch) !== -1) {
+    push.log('You do not have permission to write to this branch');
+    push.reject();
+  } else {
+    push.accept();
+  }
 });
 
 repos.on('fetch', (fetch) => {

src/git.test.ts

@@ -3,7 +3,7 @@ import path from 'path';
 import { spawn, exec, SpawnOptionsWithoutStdio } from 'child_process';
 import http from 'http';
 
-import { Git } from './git';
+import { Git, GitAuthenticateOptions } from './git';
 
 jest.setTimeout(15000);
 
@@ -15,7 +15,7 @@ const wrapCallback = (func: { (callback: any): void }) => {
 
 describe('git', () => {
   test('create, push to, and clone a repo', async () => {
-    expect.assertions(11);
+    expect.assertions(12);
 
     let lastCommit: string;
 
@@ -29,8 +29,11 @@ describe('git', () => {
     fs.mkdirSync(srcDir, '0700');
     fs.mkdirSync(dstDir, '0700');
 
-    const repos = new Git(repoDir, {
+    const repos = new Git<string>(repoDir, {
       autoCreate: true,
+      authenticate: (options: GitAuthenticateOptions) => {
+        return `my request context for repo: ${options.repo}`;
+      },
     });
     const port = Math.floor(Math.random() * ((1 << 16) - 1e4)) + 1e4;
     const server = http
@@ -42,6 +45,8 @@ describe('git', () => {
     process.chdir(srcDir);
 
     repos.on('push', (push) => {
+      expect(push.context).toBe('my request context for repo: xyz/doom');
+
       expect(push.repo).toBe('xyz/doom');
       expect(push.commit).toBe(lastCommit);
       expect(push.branch).toBe('master');
@@ -655,17 +660,16 @@ describe('git', () => {
 
     const repos = new Git(repoDir, {
       autoCreate: true,
-      authenticate: ({ type, repo, user }, next) => {
+      authenticate: async ({ type, repo, getUser }) => {
         if (type === 'fetch' && repo === 'doom') {
-          user((username, password) => {
-            if (username == 'root' && password == 'root') {
-              next();
-            } else {
-              next(new Error('that is not the correct password'));
-            }
-          });
+          const [username, password] = await getUser();
+          if (username == 'root' && password == 'root') {
+            return;
+          } else {
+            throw new Error('that is not the correct password');
+          }
         } else {
-          next(new Error('that is not the correct password'));
+          throw new Error('that is not the correct password');
         }
       },
     });
@@ -721,25 +725,30 @@ describe('git', () => {
     fs.mkdirSync(srcDir, '0700');
     fs.mkdirSync(dstDir, '0700');
 
-    const repos = new Git(repoDir, {
+    interface Context {
+      username: string;
+    }
+
+    const repos = new Git<Context>(repoDir, {
       autoCreate: true,
-      authenticate: ({ type, repo, user, headers }, next) => {
+      authenticate: async ({ type, repo, getUser, headers }) => {
         if (type === 'fetch' && repo === 'doom') {
           expect(headers['host']).toBeTruthy();
           expect(headers['user-agent']).toBeTruthy();
           expect(headers['accept']).toBeTruthy();
           expect(headers['pragma']).toBeTruthy();
           expect(headers['accept-encoding']).toBeTruthy();
 
-          user((username, password) => {
-            if (username == 'root' && password == 'root') {
-              next();
-            } else {
-              next(new Error('that is not the correct password'));
-            }
-          });
+          const [username, password] = await getUser();
+          if (username == 'root' && password == 'root') {
+            return {
+              username: username,
+            };
+          } else {
+            throw new Error('that is not the correct password');
+          }
         } else {
-          next(new Error('that is not the correct password'));
+          throw new Error('that is not the correct password');
         }
       },
     });
@@ -795,20 +804,14 @@ describe('git', () => {
 
     const repos = new Git(repoDir, {
       autoCreate: true,
-      authenticate: ({ type, repo, user }) => {
-        return new Promise(function (resolve, reject) {
-          if (type === 'fetch' && repo === 'doom') {
-            user((username, password) => {
-              if (username == 'root' && password == 'root') {
-                return resolve(void 0);
-              } else {
-                return reject('that is not the correct password');
-              }
-            });
-          } else {
-            return reject('that is not the correct password');
+      authenticate: async ({ type, repo, getUser }) => {
+        if (type === 'fetch' && repo === 'doom') {
+          const [username, password] = await getUser();
+          if (username == 'root' && password == 'root') {
+            return;
           }
-        });
+        }
+        throw new Error('that is not the correct password');
       },
     });
     const port = Math.floor(Math.random() * ((1 << 16) - 1e4)) + 1e4;