├── .gitignore
├── LICENSE
├── README.md
├── abac-pep-spring-security
├── build.gradle
└── src
│ ├── main
│ ├── java
│ │ └── com
│ │ │ └── github
│ │ │ └── joffryferrater
│ │ │ └── pep
│ │ │ ├── BeanConfiguration.java
│ │ │ ├── PdpConfiguration.java
│ │ │ ├── client
│ │ │ └── PdpClient.java
│ │ │ └── security
│ │ │ ├── AbacMethodSecurityExpression.java
│ │ │ ├── AbacMethodSecurityExpressionHandler.java
│ │ │ └── AbacWebSecurityExpressionHandler.java
│ └── resources
│ │ └── application.properties
│ └── test
│ ├── java
│ └── com
│ │ └── github
│ │ └── joffryferrater
│ │ └── pep
│ │ ├── TestBase.java
│ │ ├── client
│ │ └── PdpClientTest.java
│ │ └── security
│ │ └── AbacMethodSecurityExpressionTest.java
│ └── resources
│ └── application.properties
├── build.gradle
├── diagram.png
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── xacml-resource-models
├── build.gradle
└── src
└── main
└── java
└── com
└── github
└── joffryferrater
├── request
├── AccessSubjectCategory.java
├── ActionCategory.java
├── Attribute.java
├── Attributes.java
├── Category.java
├── Constants.java
├── EnvironmentCategory.java
├── Request.java
├── ResourceCategory.java
└── XacmlRequest.java
└── response
├── Attribute.java
├── AttributeAssignment.java
├── Attributes.java
├── IdReference.java
├── ObligationOrAdvice.java
├── PolicyIdentifier.java
├── Response.java
├── Result.java
├── Status.java
└── StatusCode.java
/.gitignore:
--------------------------------------------------------------------------------
1 | .gradle
2 | /build/
3 | **/build/**
4 | **/out/**
5 | xacml-resource-models/build/
6 | !gradle/wrapper/gradle-wrapper.jar
7 |
8 | ### STS ###
9 |
10 | .apt_generated
11 | .classpath
12 | .factorypath
13 | .project
14 | .settings
15 | .springBeans
16 | .sts4-cache
17 |
18 | ### IntelliJ IDEA ###
19 | .idea
20 | *.iws
21 | *.iml
22 | *.ipr
23 | /out/
24 |
25 | ### NetBeans ###
26 | /nbproject/private/
27 | /build/
28 | /nbbuild/
29 | /dist/
30 | /nbdist/
31 | /.nb-gradle/
32 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Attribute Based Access Control for Spring Security
2 | 
3 | ## What is Attribute Based Access Control (ABAC)
4 | Here is an [article](https://www.axiomatics.com/blog/intro-to-attribute-based-access-control-abac/) to get started with Attribute Based Access Control. and the XACML reference architecture [here](https://www.axiomatics.com/blog/xacml-reference-architecture/).
5 |
6 | ## About this Project
7 | The Attribute Based Access Control (ABAC) for Spring Security is a Policy Enforcment Point (PEP) implementation which provides both method and web expressions to secure Spring Boot applications based on attributes evaluated against a policy from a Policy Decision Point (PDP) server.
8 | The expressions are called ``#abac.evaluate(Category... categories)`` and ``#abac.evaluateAttributes(String... attributes)`` which send authorization request based on [Json Profile of XACML 3.0 Specification](http://docs.oasis-open.org/xacml/xacml-json-http/v1.0/xacml-json-http-v1.0.html)
9 |
10 | When using ``#abac.evaluateAttributes(String... attributes)``, the array of Strings must follow the format below:
11 | ``access-subject::``
12 | ``resource::``
13 | ``action::``
14 | ``environment::``
15 |
16 | When using ``#abac.evaluate(Category... categories)`` where the arguments is an array of Category objects, the following expressions may be used as arguments:
17 | ``#abac.accessSubjectAttribute(, {})``
18 | ``#abac.resourceAttribute(, {})``
19 | ``#abac.actionAttribute(, {})``
20 | ``#abac.environmentAttribute(, {})``
21 |
22 | ## How to use
23 | 1. Build and publish this project to maven local: ``$ ./gradlew clean build publishToMavenLocal``
24 | 2. Add the two published artifacts from maven local together with the Spring Security to your Spring Boot project dependency. Example for gradle project:
25 | ``compile('org.springframework.boot:spring-boot-starter-security')``
26 | ``compile('com.github.joffryferrater:abac-pep-spring-security:0.5.1')``
27 | ``compile('com.github.joffryferrater:xacml-resource-models:0.5.1')``
28 | 3. Add the PDP server information in the application.properties file using the properties below:
29 | ````properties
30 | pdp.server.authorize-endpoint=http://localhost:8083/authorize
31 | pdp.server.username=pdp-user
32 | pdp.server.password=password
33 | pdp.server.print-authorization-request=true
34 | ````
35 | The ``pdp.server.print-authorization-request`` property is useful for debugging purposes. It prints the authorization request on the console.
36 | ````bash
37 | 01-01-2019 17:46:56.120 [http-nio-8888-exec-6] INFO com.github.joffryferrater.pep.client.PdpClient.printAuthorizationRequest - Authorization Request --> {"Request":{"Resource":[{"Attribute":[{"AttributeId":"Attributes.resource.endpoint","Value":["helloWorld/someId"]}]}]}}
38 | 4. Include ``org.github.joffryferrater.pep`` in the scanBasePackages of your Spring Boot app. See example below:
39 | ```java
40 | import org.springframework.boot.SpringApplication;
41 | import org.springframework.boot.autoconfigure.SpringBootApplication;
42 |
43 | @SpringBootApplication(
44 | scanBasePackages={
45 | "com.github.joffryferrater.sampleappwithxacmlpepspringsecurity",
46 | "com.github.joffryferrater.pep" //Scans the abac-spring-security configurations
47 | })
48 | public class SampleAppWithXacmlPepSpringSecurityApplication {
49 |
50 | public static void main(String[] args) {
51 | SpringApplication.run(SampleAppWithXacmlPepSpringSecurityApplication.class, args);
52 | }
53 | }
54 | ````
55 | 5. Create a global method security and web security configurations.
56 |
57 | ##### An example of using Method Security expression:
58 | ````java
59 | import com.github.joffryferrater.pep.security.AbacMethodSecurityExpressionHandler;
60 | import org.springframework.context.annotation.Configuration;
61 | import org.springframework.security.access.expression.method.MethodSecurityExpressionHandler;
62 | import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
63 | import org.springframework.security.config.annotation.method.configuration.GlobalMethodSecurityConfiguration;
64 |
65 | @Configuration
66 | @EnableGlobalMethodSecurity(prePostEnabled = true)
67 | public class MethodSecurityConfig extends GlobalMethodSecurityConfiguration {
68 |
69 | @Override
70 | protected MethodSecurityExpressionHandler createExpressionHandler() {
71 | return new AbacMethodSecurityExpressionHandler();
72 | }
73 | }
74 | ````
75 | Here we created a GlobalMethodSecurityConfiguration where we use ``AbacMethodSecurityExpressionHandler()`` which is provided by this project in order to use the expression ``#abac.evaluate`` and ``#abac.evaluateAttributes`` in ``@PreAuthorize`` annotation.
76 |
77 | Annotate the resource to be protected by ``@PreAuthorize(#abac.evaluate({))``. Example below:
78 | ````java
79 | import java.security.Principal;
80 | import org.springframework.security.access.prepost.PreAuthorize;
81 | import org.springframework.web.bind.annotation.GetMapping;
82 | import org.springframework.web.bind.annotation.PathVariable;
83 | import org.springframework.web.bind.annotation.RestController;
84 |
85 | @RestController
86 | public class SampleResource {
87 | private static final String HELLOWORLD_ACCESS = "#abac.evaluate("
88 | + "{#abac.resourceAttribute('Attributes.resource.endpoint', {'helloWorld'}), "
89 | + "#abac.accessSubjectAttribute('urn:oasis:names:tc:xacml:1.0:subject:subject-id', {#principal.name})})";
90 | private static final String HELLOWORLD_ID_ACCESS = "#abac.evaluateAttributes({'resource:Attributes.resource.endpoint:helloWorld/'+#id})";
91 |
92 | @GetMapping("/helloWorld")
93 | @PreAuthorize(HELLOWORLD_ACCESS)
94 | public String printHelloWorld(Principal principal) {
95 | return "hello world";
96 | }
97 |
98 | @GetMapping("/helloWorld/{id}")
99 | @PreAuthorize(HELLOWORLD_ID_ACCESS)
100 | public String getHelloWorldId(@PathVariable String id) {
101 | return "hello world id is: " + id;
102 | }
103 |
104 | /**
105 | *
106 | * Secured by Web Security expression, see @link{#WebSecurityConfig}
107 | */
108 | @GetMapping("/securedPath")
109 | public String getSecuredPath() {
110 | return "This is the /securedPath ";
111 | }
112 | }
113 | ````
114 | In the example above, the ``/helloWorld`` resource is protected with ``@PreAuthorize`` annotation with the abac expression. The ``#abac.evaluate`` send the following authorization request to a PDP server.
115 | `````json
116 | {
117 | "Request": {
118 | "AccessSubject": [{
119 | "Attribute": [{
120 | "AttributeId": "urn:oasis:names:tc:xacml:1.0:subject:subject-id",
121 | "Value": ["Alice"]
122 | }]
123 | }],
124 | "Resource": [{
125 | "Attribute": [{
126 | "AttributeId": "Attributes.resource.endpoint",
127 | "Value": ["helloWorld"]
128 | }]
129 | }]
130 | }
131 | }
132 | `````
133 | where the value Alice is the current user name and the value helloWorld is the protected resource.
134 |
135 | ##### An example of using Web Security expression:
136 | ````java
137 | import com.github.joffryferrater.pep.security.AbacWebSecurityExpressionHandler;
138 | import org.springframework.context.annotation.Bean;
139 | import org.springframework.context.annotation.Configuration;
140 | import org.springframework.http.HttpMethod;
141 | import org.springframework.security.config.annotation.web.builders.HttpSecurity;
142 | import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
143 | import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
144 |
145 | @Configuration
146 | @EnableWebSecurity
147 | public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
148 |
149 | private static final String SECURED_PATH_ACCESS = "#abac.evaluateAttributes('resource:Attributes.resource.endpoint:securedPath', 'action:Attributes.action-id:read')";
150 |
151 | @Autowired
152 | private ApplicationContext applicationContext;
153 |
154 | @Override
155 | protected void configure(HttpSecurity http) throws Exception {
156 | http.csrf().disable()
157 | .formLogin()
158 | .and()
159 | .authorizeRequests()
160 | .expressionHandler(webSecurityExpressionHandler())
161 | .antMatchers(HttpMethod.GET, "/securedPath").access(SECURED_PATH_ACCESS)
162 | .anyRequest().authenticated();
163 |
164 | }
165 |
166 | private AbacWebSecurityExpressionHandler webSecurityExpressionHandler() {
167 | return this.applicationContext.getBean(AbacWebSecurityExpressionHandler.class);
168 | }
169 |
170 | }
171 |
172 | ````
173 | Here we created a Web Security Configuration and we set the expression handler as ``AbacWebSecurityExpressionHandler`` which is also provided by this project in order to use ``#abac.evaluate`` and ``#abac.evaluateAttributes`` expressions in ``access()`` as access expressions for securing the resource /securedPath.
174 |
175 | #### See sample project here: https://github.com/jferrater/sample-app-with-abac-spring-security
176 |
--------------------------------------------------------------------------------
/abac-pep-spring-security/build.gradle:
--------------------------------------------------------------------------------
1 | buildscript {
2 | ext {
3 | springBootVersion = '2.0.2.RELEASE'
4 | }
5 | repositories {
6 | mavenCentral()
7 | }
8 | }
9 |
10 | plugins {
11 | id 'java'
12 | id 'maven'
13 | id 'maven-publish'
14 | }
15 |
16 | apply plugin: 'eclipse'
17 |
18 | dependencies {
19 | compile project(":xacml-resource-models")
20 |
21 | compile group: 'org.springframework.boot', name: 'spring-boot-starter', version: springBootVersion
22 | compile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: springBootVersion
23 | compile group: 'org.springframework.boot', name: 'spring-boot-starter-security', version: springBootVersion
24 |
25 | compileOnly group: 'org.springframework.boot', name: 'spring-boot-configuration-processor', version: springBootVersion
26 |
27 | testCompile group: 'junit', name: 'junit', version: '4.12'
28 | testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: springBootVersion
29 | }
30 |
31 | compileJava.dependsOn(processResources)
32 |
33 | publishing {
34 | publications {
35 | jar(MavenPublication) {
36 | from components.java
37 | }
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/abac-pep-spring-security/src/main/java/com/github/joffryferrater/pep/BeanConfiguration.java:
--------------------------------------------------------------------------------
1 | package com.github.joffryferrater.pep;
2 |
3 | import com.github.joffryferrater.pep.client.PdpClient;
4 | import org.springframework.boot.web.client.RestTemplateBuilder;
5 | import org.springframework.context.annotation.Bean;
6 | import org.springframework.context.annotation.Configuration;
7 |
8 | @Configuration
9 | public class BeanConfiguration {
10 |
11 | @Bean
12 | public PdpConfiguration pdpConfiguration() {
13 | return new PdpConfiguration();
14 | }
15 |
16 | @Bean
17 | public PdpClient pdpClient(RestTemplateBuilder restTemplateBuilder) {
18 | restTemplateBuilder.setConnectTimeout(5000);
19 | final PdpConfiguration pdpConfiguration = pdpConfiguration();
20 | final String username = pdpConfiguration.getUsername();
21 | final String password = pdpConfiguration.getPassword();
22 | if (username != null && password != null) {
23 | restTemplateBuilder.basicAuthorization(username, password);
24 | }
25 | return new PdpClient(restTemplateBuilder, pdpConfiguration());
26 | }
27 | }
28 |
29 |
--------------------------------------------------------------------------------
/abac-pep-spring-security/src/main/java/com/github/joffryferrater/pep/PdpConfiguration.java:
--------------------------------------------------------------------------------
1 | package com.github.joffryferrater.pep;
2 |
3 | import org.springframework.boot.context.properties.ConfigurationProperties;
4 | import org.springframework.stereotype.Component;
5 |
6 | @ConfigurationProperties(prefix = "pdp.server")
7 | @Component
8 | public class PdpConfiguration {
9 |
10 | private String authorizeEndpoint;
11 | private String username;
12 | private String password;
13 | private boolean printAuthorizationRequest;
14 |
15 | public boolean isPrintAuthorizationRequest() {
16 | return printAuthorizationRequest;
17 | }
18 |
19 | public void setPrintAuthorizationRequest(boolean printAuthorizationRequest) {
20 | this.printAuthorizationRequest = printAuthorizationRequest;
21 | }
22 |
23 | public String getUsername() {
24 | return username;
25 | }
26 |
27 | public void setUsername(String username) {
28 | this.username = username;
29 | }
30 |
31 | public String getPassword() {
32 | return password;
33 | }
34 |
35 | public void setPassword(String password) {
36 | this.password = password;
37 | }
38 |
39 | public String getAuthorizeEndpoint() {
40 | return authorizeEndpoint;
41 | }
42 |
43 | public void setAuthorizeEndpoint(String authorizeEndpoint) {
44 | this.authorizeEndpoint = authorizeEndpoint;
45 | }
46 |
47 |
48 | }
49 |
--------------------------------------------------------------------------------
/abac-pep-spring-security/src/main/java/com/github/joffryferrater/pep/client/PdpClient.java:
--------------------------------------------------------------------------------
1 | package com.github.joffryferrater.pep.client;
2 |
3 | import com.fasterxml.jackson.core.JsonProcessingException;
4 | import com.fasterxml.jackson.databind.ObjectMapper;
5 | import com.github.joffryferrater.pep.PdpConfiguration;
6 | import com.github.joffryferrater.request.XacmlRequest;
7 | import com.github.joffryferrater.response.Response;
8 | import org.slf4j.Logger;
9 | import org.slf4j.LoggerFactory;
10 | import org.springframework.boot.web.client.RestTemplateBuilder;
11 | import org.springframework.http.HttpEntity;
12 | import org.springframework.http.HttpHeaders;
13 | import org.springframework.stereotype.Service;
14 | import org.springframework.web.client.RestTemplate;
15 |
16 | @Service
17 | public class PdpClient {
18 |
19 | private static final Logger LOGGER = LoggerFactory.getLogger(PdpClient.class);
20 |
21 | private final RestTemplate restTemplate;
22 | private PdpConfiguration pdpConfiguration;
23 |
24 | public PdpClient(RestTemplateBuilder restTemplateBuilder, PdpConfiguration pdpConfiguration) {
25 | this.restTemplate = restTemplateBuilder.build();
26 | this.pdpConfiguration = pdpConfiguration;
27 | }
28 |
29 | public Response sendXacmlJsonRequest(XacmlRequest xacmlRequest) {
30 | printAuthorizationRequest(xacmlRequest);
31 | HttpHeaders headers = createHeaders();
32 | HttpEntity entity = new HttpEntity<>(xacmlRequest, headers);
33 | final String url = pdpConfiguration.getAuthorizeEndpoint();
34 | return restTemplate.postForObject(url, entity, Response.class);
35 | }
36 |
37 | private HttpHeaders createHeaders() {
38 | HttpHeaders headers = new HttpHeaders();
39 | headers.add("Content-Type", "application/xacml+json");
40 | headers.add("Accept", "application/json");
41 | return headers;
42 | }
43 |
44 | private void printAuthorizationRequest(XacmlRequest xacmlRequest) {
45 | if (pdpConfiguration.isPrintAuthorizationRequest()) {
46 | ObjectMapper objectMapper = new ObjectMapper();
47 | try {
48 | final String requestInString = objectMapper.writeValueAsString(xacmlRequest);
49 | LOGGER.info("Authorization Request --> {}", requestInString);
50 | } catch (JsonProcessingException e) {
51 | //Do nothing
52 | }
53 | }
54 | }
55 | }
56 |
57 |
--------------------------------------------------------------------------------
/abac-pep-spring-security/src/main/java/com/github/joffryferrater/pep/security/AbacMethodSecurityExpression.java:
--------------------------------------------------------------------------------
1 | package com.github.joffryferrater.pep.security;
2 |
3 | import com.github.joffryferrater.pep.client.PdpClient;
4 | import com.github.joffryferrater.request.AccessSubjectCategory;
5 | import com.github.joffryferrater.request.ActionCategory;
6 | import com.github.joffryferrater.request.Attribute;
7 | import com.github.joffryferrater.request.Category;
8 | import com.github.joffryferrater.request.EnvironmentCategory;
9 | import com.github.joffryferrater.request.Request;
10 | import com.github.joffryferrater.request.ResourceCategory;
11 | import com.github.joffryferrater.request.XacmlRequest;
12 | import com.github.joffryferrater.response.Response;
13 | import java.util.ArrayList;
14 | import java.util.Collections;
15 | import java.util.List;
16 | import org.slf4j.Logger;
17 | import org.slf4j.LoggerFactory;
18 |
19 | public class AbacMethodSecurityExpression {
20 |
21 | private static final Logger LOGGER = LoggerFactory.getLogger(AbacMethodSecurityExpression.class);
22 |
23 | private final PdpClient pdpClient;
24 |
25 | public AbacMethodSecurityExpression(PdpClient pdpClient) {
26 | this.pdpClient = pdpClient;
27 | }
28 |
29 | public boolean evaluateAttributes(String... attributes) {
30 | List accessSubjectCategories = new ArrayList<>();
31 | List resourceCategories = new ArrayList<>();
32 | List actionCategories = new ArrayList<>();
33 | List environmentCategories = new ArrayList<>();
34 | for (String attribute : attributes) {
35 | String[] expression = attribute.split(":", 3);
36 | addAccessSubjectAttribute(accessSubjectCategories, expression);
37 | addResourceAttribute(resourceCategories, expression);
38 | addActionAttribute(actionCategories, expression);
39 | addEnvironmentAttribute(environmentCategories, expression);
40 | }
41 | return evaluateAuthorizationRequest(accessSubjectCategories, resourceCategories, actionCategories,
42 | environmentCategories);
43 | }
44 |
45 | private boolean evaluateAuthorizationRequest(List accessSubjectCategories,
46 | List resourceCategories, List actionCategories,
47 | List environmentCategories) {
48 | Request request = buildRequest(resourceCategories, accessSubjectCategories, actionCategories,
49 | environmentCategories);
50 | final Response pdpResponse = getAuthorizationResponse(request);
51 | return isPermitted(pdpResponse);
52 | }
53 |
54 | private void addAccessSubjectAttribute(List accessSubjectCategories, String[] expression) {
55 | if ("access-subject".equals(expression[0])) {
56 | AccessSubjectCategory accessSubjectCategory = accessSubjectAttribute(expression[1],
57 | Collections.singletonList(expression[2]));
58 | accessSubjectCategories.add(accessSubjectCategory);
59 | }
60 | }
61 |
62 | private void addResourceAttribute(List resourceCategories, String[] expression) {
63 | if ("resource".equals(expression[0])) {
64 | ResourceCategory resourceCategory = resourceAttribute(expression[1],
65 | Collections.singletonList(expression[2]));
66 | resourceCategories.add(resourceCategory);
67 | }
68 | }
69 |
70 | private void addActionAttribute(List actionCategories, String[] expression) {
71 | if ("action".equals(expression[0])) {
72 | ActionCategory actionCategory = actionAttribute(expression[1], Collections.singletonList(expression[2]));
73 | actionCategories.add(actionCategory);
74 | }
75 | }
76 |
77 | private void addEnvironmentAttribute(List environmentCategories, String[] expression) {
78 | if ("environment".equals(expression[0])) {
79 | EnvironmentCategory environmentCategory = environmentAttribute(expression[1],
80 | Collections.singletonList(expression[2]));
81 | environmentCategories.add(environmentCategory);
82 | }
83 | }
84 |
85 | public boolean evaluate(Category... categories) {
86 | List resourceCategories = new ArrayList<>();
87 | List accessSubjectCategories = new ArrayList<>();
88 | List actionCategories = new ArrayList<>();
89 | List environmentCategories = new ArrayList<>();
90 | for (Category category : categories) {
91 | if (category instanceof ResourceCategory) {
92 | ResourceCategory resourceCategory = (ResourceCategory) category;
93 | resourceCategories.add(resourceCategory);
94 | }
95 | if (category instanceof AccessSubjectCategory) {
96 | AccessSubjectCategory accessSubjectCategory = (AccessSubjectCategory) category;
97 | accessSubjectCategories.add(accessSubjectCategory);
98 | }
99 | if (category instanceof ActionCategory) {
100 | ActionCategory actionCategory = (ActionCategory) category;
101 | actionCategories.add(actionCategory);
102 | }
103 | if (category instanceof EnvironmentCategory) {
104 | EnvironmentCategory environmentCategory = (EnvironmentCategory) category;
105 | environmentCategories.add(environmentCategory);
106 | }
107 |
108 | }
109 | return evaluateAuthorizationRequest(accessSubjectCategories, resourceCategories, actionCategories,
110 | environmentCategories);
111 | }
112 |
113 | public ResourceCategory resourceAttribute(String attributeId, List