Giter Club home page Giter Club logo

roxas's Introduction

Roxas

Roxas is a new authentication solution for CSH. You can register an iButton/RFID/NFC reader on the site and then use the authentication API to authenticate a user with the registered device.

Usage

The easiest way to use the authentication API is to use the RoxasAuth Python wrapper. If that's not an option, instructions on using the API are listed below.

For ibutton authentication, make a POST request to https://roxas.csh.rit.edu/ibutton/auth with a JSON payload containing the device's API key as api_key, the user's ibutton serial number as ibutton, and a list of desired LDAP attributes to be returned for the user as attrs.

Below is an example in Python:

>>> import requests
>>>
>>> url = "https://roxas.csh.rit.edu/ibutton/auth"
>>> data = {
    'api_key': 'API_KEY',
    'ibutton': '4F0A0D0022824A01',
    'attrs': ['uid', 'entryUUID', 'roomNumber']
}
>>>
>>> r = requests.post(url, json=data)
>>> r.json()
{'message': 'Successfully authenticated user.', 'can_access': True, 'returned_attrs': {'uid': 'tcohen', 'entryUUID': 'ba9b46f4-94cb-1031-9eb0-1fc026a2fe14', 'roomNumber': '3074'}}

A JSON object is returned with three keys: whether the user can access the device or not, a message, and the requested attributes as a dictionary of attributes to their values, as shown in the example above.

For NFC authentication, TO BE FINISHED

roxas's People

Watchers

 avatar  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.