Code Monkey home page Code Monkey logo

msisdn-gateway's Introduction

MSISDN Gateway

This is a PoC of an MSISDN Gateway server that takes a phone number an register it using an SMS validation.

It implements the proposal here : ./API.md

The API are discussed on the loop-dev mailing list at https://mail.mozilla.org/listinfo/loop-dev

Registration process flow

  1. The client make a /register request.

-- The server choose the verification process based on MSISDN, MCC and MNC codes and return a sessionToken and a verify endpoint.

  1. The client make a /sms/verify (verify endpoint) request

-- The server send a SMS with a code and return the number used to send it (for silent SMS catch)

  1. The client ask for /verify_code with the sessionToken and the code and get a BrowserID certificate.
  2. If needed the client can also ask for a new code with /sms/resend_code and its sessionToken.
  3. Finally the client can destroy its registration using /unregister and its sessionToken.

How to install?

You will need redis-server installed:

Linux

apt-get install redis-server

OS X

Assuming you have brew installed, use it to install redis:

brew install redis

If you need to restart it (after configuration update):

brew services restart redis

All Platforms

Then clone the loop server and install its dependencies:

git clone https://github.com/mozilla-services/msisdn-gateway.git
cd msisdn-gateway && make install

How to run it?

You can create your configuration file in config/{NODE_ENV}.json

development is the environment by default.

make runserver

this is equivalent to:

NODE_ENV=development make runserver

How to run the tests?

make test

Where to report bugs?

You should report bugs/issues or feature requests via Github Issues

License

The MSISDN Gateway code is released under the terms of the Mozilla Public License v2.0. See the LICENSE file at the root of the repository.

msisdn-gateway's People

Contributors

natim avatar tarekziade avatar

Watchers

Fernando Jiménez Moreno avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.