-
Notifications
You must be signed in to change notification settings - Fork 332
DOCS: OPA as External Policy Decision Point #3030
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sungwy
wants to merge
6
commits into
apache:main
Choose a base branch
from
sungwy:opa-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+545
β4
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
site/content/in-dev/unreleased/managing-security/external-pdp/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| # | ||
| title: External Policy Decision Point | ||
| linkTitle: External PDP | ||
| type: docs | ||
| weight: 300 | ||
| --- | ||
|
|
||
| This section provides information about integrating Apache Polaris (Incubating) with external Policy Decision Points (PDPs) for authorization. | ||
|
|
||
| ## Overview | ||
|
|
||
| By default, Apache Polaris uses an internal authorization system based on role-based access control (RBAC). For advanced use cases requiring external policy management, centralized authorization, or integration with existing policy infrastructure, Polaris supports integration with external Policy Decision Points (PDPs). | ||
|
|
||
| ## What is a Policy Decision Point? | ||
|
|
||
| A Policy Decision Point (PDP) is a component that evaluates authorization requests against defined policies and returns authorization decisions (allow/deny). | ||
|
|
||
| Organizations may choose to use an external PDP instead of Polaris's internal authorization in order to leverage a centralized policy store that manages authorization policies across multiple services and applications. | ||
|
|
||
| ## Architecture | ||
|
|
||
| When using an external PDP, Polaris delegates authorization decisions as follows: | ||
|
|
||
| 1. **Client request**: A client makes a request to Polaris (e.g., read a table) | ||
| 2. **Authorization check**: Polaris sends an authorization request to the external PDP | ||
| 3. **Policy evaluation**: The PDP evaluates the request against configured policies | ||
| 4. **Decision**: The PDP returns an allow/deny decision | ||
| 5. **Enforcement**: Polaris enforces the decision and proceeds or rejects the request | ||
|
|
||
| ``` | ||
| βββββββββββ βββββββββββββββ ββββββββββββββββ | ||
| β Client ββββββββββ>β Polaris βββββββββ>β External PDP β | ||
| β β Request β β AuthZ β β | ||
| β β β β Request β β | ||
| β β<ββββββββββ β<βββββββββ β | ||
| β β Response β β Decisionβ β | ||
| βββββββββββ βββββββββββββββ ββββββββββββββββ | ||
| ``` | ||
|
|
||
| ## Available Implementations | ||
|
|
||
| Apache Polaris currently supports the following external PDP integrations: | ||
|
|
||
| - **[Open Policy Agent (OPA)]({{< relref "opa.md" >}})**: A general-purpose policy engine with a rich ecosystem and flexible policy language (Rego) | ||
|
|
||
| ## Configuration | ||
|
|
||
| To enable external PDP integration, set the following configuration property: | ||
|
|
||
| ```properties | ||
| polaris.authorization.type=<pdp-type> | ||
| ``` | ||
|
|
||
| Where `<pdp-type>` is the identifier for the PDP implementation (e.g., `opa`). The default value is `internal`. | ||
|
|
||
| See the specific PDP documentation for detailed configuration options: | ||
|
|
||
| - [OPA Configuration]({{< relref "opa.md#configuration-reference" >}}) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The front-matter ending is missing now. That's probably why CI fails.