/meteor-oauth2-server

OAuth 2.0 server implemented for Meteor

Primary LanguageJavaScriptMIT LicenseMIT

Meteor OAuth2 Server

Use your meteor application as an oauth2 server. This package will give the developer the tools necessary to get oauth2 running easily. Look at the resourceServer example for a detailed demonstration on how to get things working.

Installation

meteor add Cores-ts:meteor-oauth2-server

Observation

In order to edit the package at the develop time, you have to define a constant, like:

export METEOR_PACKAGE_DIRS=<dir with packages>

So, you can edit the package itself and the project will auto-refresh with the last version.

API

oauth - Exported so all code in meteor can access the functionality.

  • pubSubNames

    • authCodes - Constant string representing the auth codes pub/sub.

    • refreshTokens - Constant string representing the refresh token pub/sub.

  • methodNames

    • authorize - Constant string representing th authCodeGran meteor method.

  • collections

    • refreshToken - Collection of the refresh tokens.

    • authCode - Collection of the authorization codes.

    • accessToken - (server) Collection of the access tokens.

    • client - (server) Collection of the clients authorized to use the oauth2 service.

  • oauthserver - (server) Underlying node-oauth2-server object used to handle the oauth2 requests and responses.

  • subscribeTo (client)

    • authCode - Wrapper function to subscribe to the auth code subscription. Returns a standard subscription handle.

    Example:

        // subscribe to a user's authorization codes.
    oauth.subscribeTo.authCode();
    • refreshTokens - Wrapper function subscribe to the refresh tokens subscription. Returns a standard subscription handle.

    Example:

       // subscribe to a user's refresh tokens.
   oauth.subscribeTo.refreshTokens();

  • callMethod (client)

    • authorize - Wrapper for Meteor.method to create an authorization code. This is an async function and a callback must be provided to be of any use.

    Example:

    oauth.callMethod.authorize(client_id, redirect_uri, response_type, scope, state, function(err, authorizeResult) {
    // see below for a description of authorizeResult
});

    authorizeResult

    {
    success: boolean,
    error: any,
    authorizationCode: string,
    redirectToUri: string
}