Skip to content

heutelbeck/sapl-policy-engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Logo

SAPL

The Streaming Attribute Policy Language and Engine
Explore our website »

Playground · Demos · Report an issue · Discord

Build Status SonarCloud Status Security Rating Maven Central Maven Snapshots OpenSSF Scorecard OpenSSF Best Practices

About The Project

The reactive open-source engine for adding Attribute-Based Access Control (ABAC) to your Java applications, supporting attribute streams for efficient interactive real-time access control.

SAPL is a powerful policy language and engine for implementing ABAC. It comes with development tools for testing, authorization servers, and authoring tools. Framework integrations are available for Spring, Axon, and Vaadin to provide flexible policy enforcement points (PEPs) in your application.

For an explanation, overview, and documentation about the SAPL project look up our website.

Getting Started

To get started with integrating SAPL into your Java application, add the following reference to your build tool project definition.

We recommend using the SNAPSHOT version as the latest stable version is outdated.

Maven

<dependency>
  <groupId>io.sapl</groupId>
  <artifactId>sapl-pdp-embedded</artifactId>
  <version>2.0.1</version>
</dependency>

Gradle

dependencies {
  implementation 'io.sapl:sapl-pdp-embedded:2.0.1'
}

This enables you to use the interface PolicyDecisionPoint to decide about requests.

Want to integrate and understand the full scale of capabilities of SAPL? Visit our website.

Want to see integration examples? View our dedicated demos.

Feeling experimental? Use our snapshots for the newest development state!

IDE-Support

SAPL Eclipse Plug-in

Get code editing support in Eclipse by installing the SAPL Plug-in: [Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client](/marketplace-client-intro?mpc_install=5795798"Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client")

IntelliJ IDEA Plug-in

Get code editing support by installing the SAPL Plug-in for IntelliJ IDEA.

Other IDEs

SAPL provides a language server for the integration into other IDEs which support the language server protocol. For details see sapl-language-server.

Want to integrate SAPL?

SAPL supports different integration scenarios, which are partially described on our website.

If you want to see examples, view our demo repository to give you a gist about how you could integrate SAPL.

Need a SBOM? View here.

Want to contribute to SAPL?

Any contributions you make are greatly appreciated.

See our Contribution document for more detailed information on how to contribute.

Found a vulnerability?

The project is committed to identifying and eliminating any potential weaknesses in its security.

See our Security document for more detailed information on how to report vulnerabilities.

Snapshots

This project provides snapshots of the newest development state to enable testing and integration.

Be careful when using snapshots as they may be broken!

To add snapshot references to your project add the following references to your build tool project definition.

Maven

By default, Maven only retrieves dependencies from the central releases repository. To get access to the snapshot builds, the matching snapshots repository must be added to the projects pom.xml.

<repositories>
  <repository>
    <id>ossrh</id>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>

After doing so, the projects now has access to the SAPL snapshot builds which can be added as follows:

<dependencies>
  <dependency>
    <groupId>io.sapl</groupId>
    <artifactId>sapl-{package}</artifactId>
    <version>3.0.0-SNAPSHOT</version>
  </dependency>
</dependencies>

Gradle

By default, Gradle only retrieves dependencies from the central releases repository. To get access to the snapshot builds, the matching snapshots repository must be added to the project configuration.

repositories {
  maven {
    url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots")
  }
}

dependencies {
  implementation 'io.sapl:sapl-{package}3.0.0-SNAPSHOT'
}

You need to replace {package} with the designated project!

Code of Conduct

This project has adopted a Code of Conduct, and it will be enforced in any communication.

License

Distributed under the Apache 2.0 License. See LICENSE.md for more information.