koa-gitlab

simple gitlab auth middleware for koa

Example

const Koa = require('koa');
const session = require('koa-session');
const gitlabAuth = require('./');

const app = new Koa();

app.name = 'nae-web';
app.keys = ['key1', 'key2'];

app.use(session(app));

app.use(
    gitlabAuth({
        clientID:
            'c5cab72c81c43289f918367e651af278bbf967c8a5de2b406c0ce8831eacfeaa',
        clientSecret:
            'b4c56b6aed0d2eef0ffcf34ae5c975729e718be0a0041a83daa5564974e46a06',
        callbackURL: 'http://localhost:7001/gitlab/auth/callback',
        userKey: 'user',
        timeout: 10000
    })
);

app.use(async ctx => {
    if (!ctx.session.gitlabToken) {
        ctx.body =
            '<a href="/gitlab/auth?redirect_uri=/callback">login with gitlab</a>';
    } else {
        ctx.body = `<pre>${JSON.stringify(ctx.session.user, null, 4)}</pre>`;
    }
});

app.on('error', err => {
    if (!err.status || err.status >= 500) {
        console.error(err);
    }
});

app.listen(7001);

Options

  @param {Object} options
    - [String] gitlabHost    gitlab host, default is https://gitlab.com
    - [String] clientID      gitlab client ID     // regist in https://gitlab.com/profile/applications
    - [String] clientSecret  gitlab client secret
    - [String] callbackURL   gitlab redirect url
    - [String] signinPath    sign in with gitlab's triggle path, default is `/gitlab/auth`
    - [String] tokenKey      session key, default is gitlabToken
    - [String] userKey       user key, if set user key, will request gitlab once to get the user info
    - [Array]  scope         A comma separated list of scopes
    - [Number] timeout       request gitlab api timeout
    - [String] redirect      redirect key when call signinPath, so we can redirect after auth, default is `redirect_uri`

• clientID, clentSecret and callbackURL are registered in https://gitlab.com/profile/applications .
• if you set userKey field, koa-gitlab will request to get the user info and set this object to this.session[options.userKey], otherwise koa-gitlab will not do this request.
• if you triggle by /gitlab/auth?redirect_uri=/callback, koa-gitlab will redirect to /callback after auth, and the redirect_uri only accept start with /.

Thanks

• koa-github

Licences

MIT