Skip to content

rikulo/security

Repository files navigation

Rikulo Security

Rikulo Security is a lightweight and highly customizable authentication and access-control framework for Rikulo Stream.

Rikulo Security is distributed under an Apache 2.0 License.

Installation

Add this to your pubspec.yaml (or create it):

dependencies:
  rikulo_security:

Then run the Pub Package Manager (comes with the Dart SDK):

dart pub get

Usage

First, you have to implement Authenticator. For sake of description, we use a dummy implementation here called DummyAuthenticator:

 final authenticator = DummyAuthenticator()
   ..addUser("john", "123", ["user"])
   ..addUser("peter", "123", ["user", "admin"]);

Second, you can use SimpleAccessControl or implement your own access control (AccessControl):

 final accessControl = SimpleAccessControl({
   "/admin/.*": ["admin"],
   "/member/.*": ["user", "admin"]
 });

Finally, instantiate Security with the authenticator and access control you want:

 final security = Security(authenticator, accessControl);
 StreamServer(uriMapping: {
   "/s_login": security.login,
   "/s_logout": security.logout
 }, filterMapping: {
   "/.*": security.filter
 }).start();

Please refer to this sample application for more information.

Notes to Contributors

Fork Rikulo Security

If you'd like to contribute back to the core, you can fork this repository and send us a pull request, when it is ready.

Please be aware that one of Rikulo Security's design goals is to keep the sphere of API as neat and consistency as possible. Strong enhancement always demands greater consensus.

If you are new to Git or GitHub, please read this guide first.

Who Uses

  • Quire - a simple, collaborative, multi-level task management tool.
  • Keikai - a sophisticated spreadsheet for big data

About

A lightweight and highly customizable authentication and access-control framework for Rikulo Stream.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors