Git Product home page Git Product logo

auth-rs's Introduction

Auth-rs

This library provides a simple username/password authentication system to use with Rocket.

For Cookie encryption, the library uses the Private Cookie feature of Rocket. For maintaining cookie validity after a restart, do not forget to set the secret_key configuration parameter, otherwise Rocket will generate a new key at every execution.

Cargo.toml

[dependencies]
rocket = "0.3.0"
rocket-simpleauth = "0.4.0"
rocket_codegen = "0.3.0"

Example

Please check example/ directory, for a full example.

API Stability

Apart from a few functions of some traits, the API should stay the same from now on (v0.4.0). Given issue #6 it is probabel that the Authenticator trait will change.

When this crate reaches 1.0.0, the full API will be considered stable and frozen.

Todo

The following items are in development or are planned to be developped:

  • standard implementation for user storage into sqlite databases
  • publishing to crates.io
  • Documentation

On hold

See this issue

  • cookie storage in Redis datastore
  • stateless cookie validation using JSON Web Tokens

auth-rs's People

Contributors

bbigras avatar blackghost1987 avatar bramvdb avatar bramvdbogaerde avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

auth-rs's Issues

Add option to logout

It would be nice if the user could be logged of as well.
Maybe using a method on the UserPass type.

Configuration for cookie identifier not lookup in config files

Because we create a new instance of the Config struct, a new configuration context is created ignoring the existing configuration context.

So if the user changes the cookie identifier key with for example an environment variabele the change won't be included in the lookup of the config variable

Allow advanced validation of the cookie

With the introduction of private cookies in Rocket 0.3.0 the project removed the FromCookie trait that allowed users to create their own mechanism of storing cookies.

However, there are some use cases in which the user would want to have additional validation of the cookiestring aside of the validation that rocket provides.

This issue is created to invistigate this and to track the progress made on that.

Returning the authenticator on failed login

At the moment the authenticator isn't used in case of a failed login so it makes little sense to let types that implement the Authenticator trait return a reference to themselves when the login has failed.

This makes even less sense if you consider that the authenticator must be able to return a User type and thus must embed that within, but if the authentication failed such type cannot always be constructed.

Thus I propose to let the function return something else for the Error variant of the result.

Decoding of incoming form

At the moment the incoming fields of the form are not decodef properly.
They still contain url encoded versions of their characters, because of this login with a special token (like an @) will fail.

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.