@buession/shiro
Version:
A security framework for JavaScript or TypeScript.
173 lines • 5.07 kB
JavaScript
import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
import _createClass from "@babel/runtime/helpers/esm/createClass";
import { ALL_PERMISSION, DefaultPrincipal } from './core';
import { has, hasAny, hasAll } from './utils/common';
export var Shiro = /*#__PURE__*/function () {
function Shiro(principal) {
_classCallCheck(this, Shiro);
var $principal = principal;
if (typeof $principal.id === 'string' && Array.isArray($principal.roles) && Array.isArray($principal.permissions)) {
this.principal = new DefaultPrincipal($principal.id, $principal.roles, $principal.permissions);
} else {
this.principal = principal;
}
}
/**
* 验证是否为已认证通过的用户，不包含已记住的用户，这是与 isUser 标签方法的区别所在
*
* @return 用户是否已通过认证
*/
return _createClass(Shiro, [{
key: "isAuthenticated",
value: function isAuthenticated() {
return this.principal !== null;
}
/**
* 验证是否为未认证通过用户，与 isAuthenticated 标签相对应，与 isGuest 标签的区别是，该标签包含已记住用户
*
* @return 用户是否未通过认证
*/
}, {
key: "isNotAuthenticated",
value: function isNotAuthenticated() {
return this.isAuthenticated() === false;
}
/**
* 验证用户是否为访客，即未认证（包含未记住）的用户
*
* @return 用户是否为访客
*/
}, {
key: "isGuest",
value: function isGuest() {
return this.principal === null;
}
/**
* 验证用户是否认证通过或已记住的用户
*
* @return 用户是否认证通过或已记住的用户
*/
}, {
key: "isUser",
value: function isUser() {
return this.principal !== null;
}
/**
* 验证用户是否具备某角色。
*
* @param roleName
* 角色名称
*
* @return 用户是否具备某角色
*/
}, {
key: "hasRole",
value: function hasRole(roleName) {
return this.isAuthenticated() && has(this.principal.getRoles(), roleName);
}
/**
* 验证用户是否不具备某角色，与 hasRole 逻辑相反
*
* @param roleName
* 角色名称
*
* @return 用户是否不具备某角色
*/
}, {
key: "lacksRole",
value: function lacksRole(roleName) {
return this.hasRole(roleName) === false;
}
/**
* 验证用户是否具有以下任意一个角色
*
* @param roleNames
* 角色列表
*
* @return 用户是否具有以下任意一个角色
*/
}, {
key: "hasAnyRole",
value: function hasAnyRole(roleNames) {
return this.isAuthenticated() && hasAny(this.principal.getRoles(), roleNames);
}
/**
* 验证用户是否具有以下所有角色。
*
* @param roleNames
* 角色列表
*
* @return 用户是否具有以下所有角色
*/
}, {
key: "hasRolesAll",
value: function hasRolesAll(roleNames) {
return this.isAuthenticated() && hasAll(this.principal.getRoles(), roleNames);
}
/**
* 验证用户是否具备某权限
*
* @param permission
* 权限名称
*
* @return 用户是否具备某权限
*/
}, {
key: "hasPermission",
value: function hasPermission(permission) {
return this.isAuthenticated() && hasAny(this.principal.getPermissions(), [ALL_PERMISSION, permission]);
}
/**
* 验证用户是否不具备某权限，与 hasPermission 逻辑相反
*
* @param permission
* 权限名称
*
* @return 用户是否不具备某权限
*/
}, {
key: "lacksPermission",
value: function lacksPermission(permission) {
return this.hasPermission(permission) === false;
}
/**
* 验证用户是否具有以下任意一个权限
*
* @param permissions
* 权限列表
*
* @return 用户是否具有以下任意一个权限
*/
}, {
key: "hasAnyPermission",
value: function hasAnyPermission(permissions) {
return this.isAuthenticated() && hasAny(this.principal.getPermissions(), (permissions || []).concat(ALL_PERMISSION));
}
/**
* 验证用户是否具有以下所有权限
*
* @param permissions
* 权限列表
*
* @return 用户是否具有以下所有权限
*/
}, {
key: "hasAllPermissions",
value: function hasAllPermissions(permissions) {
return this.isAuthenticated() && (has(this.principal.getPermissions(), ALL_PERMISSION) || hasAll(this.principal.getPermissions(), permissions));
}
/**
* 验证用户是否具有以下所有权限
*
* @param permissions
* 权限列表
*
* @return 用户是否具有以下所有权限
*/
}, {
key: "hasPermissionsAll",
value: function hasPermissionsAll(permissions) {
return this.hasAllPermissions(permissions);
}
}]);
}();