generator-jhipster-preauthorize

JHipster blueprint, Adds PreAuthorize to each end point for each entity

Introduction

This is a JHipster blueprint, that is meant to be used in a JHipster application.

This Blueprint allows to use fine grained permissions foreach generated endpoint.

To be able to use fine grained permissions without assigning each permission/authority to a user we:

1. Replace the "Old" Authority Class with a new Role Class
2. Now that users have roles, we link their roles to the Authorities, using a new Entity RoleAuthority

Technical choices

We now have a relationship UserRole and manage it through the UserResource endpoint (the same way Jhipster does by default with UserAuthority). In the case of AccountResource, and only in that case, we would like to return the users (Fine Grained) Authorities with its roles, for an easier code we added back the field authorities to the UserDTO (only), and it is always empty except in that case. (If you have a better proposition please create an Issue and PR).

Quirks

The code would be much cleaner if we could detect foreach subgenerator, if a previous blueprint will overwrite a specific step (in our case the writing step).
We would be able to return only custom steps in that case or prepend with super steps.
Since we cannot detect that, out custom steps have as a first step, one that checks if an expect file is present and call what the main generator should have called before mving to the next ones.

In case the detection prooves to be really impossible in the future, we could make our code a bit cleaner by iterating over the steps in automatically super._writing(). foreachMethode instead of calling them manually: super._writing().write...

Prerequisites

As this is a JHipster blueprint, we expect you have JHipster and its related tools already installed:

• Installing JHipster

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-preauthorize

To update this blueprint:

npm update -g generator-jhipster-preauthorize

With Yarn

To install this blueprint:

yarn global add generator-jhipster-preauthorize

To update this blueprint:

yarn global upgrade generator-jhipster-preauthorize

Usage

To use this blueprint, run the below command

jhipster --blueprint preauthorize

Running local Blueprint version for development

During development of blueprint, please note the below steps. They are very important.

1. Link your blueprint globally

Note: If you do not want to link the blueprint(step 3) to each project being created, use NPM instead of Yarn as yeoman doesn't seem to fetch globally linked Yarn modules. On the other hand, this means you have to use NPM in all the below steps as well.

cd preauthorize
npm link

2. Link a development version of JHipster to your blueprint (optional: required only if you want to use a non-released JHipster version, like the master branch or your own custom fork)

You could also use Yarn for this if you prefer

cd generator-jhipster
npm link

cd preauthorize
npm link generator-jhipster

3. Create a new folder for the app to be generated and link JHipster and your blueprint there

mkdir my-app && cd my-app

npm link generator-jhipster-preauthorize
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster -d --blueprint preauthorize

#Contributing and debugging To bel able to run tests locally, make sure install globally the blueprints:

• generator-jhipster-default
• generator-jhipster-primeng-blueprint
• generator-jhipster-composite-key-server

with versions matching the current version of the blueprint

License

Apache-2.0 © Youssef El Houti