Skip to content

ant0ha/angular-easy-auth

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ngEasyAuth

ngEasyAuth is a simple angular library for handling security (fork of authenticateJS)

Installation

To use this library you should have a server application that handles authentication with sessions and it should have a login api that uses a username and password parameters from request body, a logout url and an api to get the current loggedin user with its credentials.

  • Install the library
bower install angular-easy-auth
  • load the library
<script src="js/angular.min.js"></script>
<script src="js/angular-route.min.js"></script>
<script src="js/angular-easy-auth.js"></script>
  • add it to your dependencies
angular.module('myapp', ['ngEasyAuth']);
  • configure
angular.module('myapp').config(['EasyAuthProvider', function (EasyAuthProvider) {

    EasyAuthProvider
        .set('host', 'api/')
        .set('loginUrl', 'login.json')
    ;

}]);

All params and default values you can see below:

Param Default value
host 'api/'
loginUrl 'login.json'
logoutUrl false
logoutMethod 'DELETE'
loggedinUrl 'users/current.json'
unauthorizedPage '/login'
targetPage '/'
loginPage '/login'
router 'ngRoute'

Usage

  • In your login page, include the login form like this
<div easy-auth-form></div>

You can override the default login form template like this

<div easy-auth-form template-url="mypartial.html"></div>
  • add a security attribute to your routes

    • a false value means that the route is not protected,
    • a true value means, you have to be loggedin to access this route,
    • other custom string can be used to indicate that a user role is required to access this route (the string represent the role that have to be found in user.roles)
  • you can call EasyAuth.logout(); to loggout

  • you cas use EasyAuth.getLoggedinUser() to get the current loggedin user

About

ngEasyAuth is a simple angular library for handling security

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%