Skip to content

Commit

Permalink
docs(jans-cedarling): rename CEDARLING_LOCAL_POLICY_STORE to `CEDAR…
Browse files Browse the repository at this point in the history
…LING_POLICY_STORE_LOCAL`

Signed-off-by: Oleh Bozhok <[email protected]>
  • Loading branch information
olehbozhok committed Feb 4, 2025
1 parent a6052ed commit 897ff29
Show file tree
Hide file tree
Showing 12 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/cedarling/cedarling-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ These Bootstrap Properties control default application level behavior.
**The following bootstrap properties are needed to configure JWT and cryptographic behavior:**

* **`CEDARLING_LOCAL_JWKS`** : JWKS file with public keys
* **`CEDARLING_LOCAL_POLICY_STORE`** : JSON object with policy store
* **`CEDARLING_POLICY_STORE_LOCAL`** : JSON object with policy store
* **`CEDARLING_POLICY_STORE_LOCAL_FN`** : Local file with JSON object with policy store
* **`CEDARLING_JWT_SIG_VALIDATION`** : `enabled` | `disabled` -- Whether to check the signature of all JWT tokens. This requires an `iss` is present.
* **`CEDARLING_JWT_STATUS_VALIDATION`** : `enabled` | `disabled` -- Whether to check the status of the JWT. On startup, the Cedarling should fetch and retreive the latest Status List JWT from the `.well-known/openid-configuration` via the `status_list_endpoint` claim and cache it. See the [IETF Draft](https://datatracker.ietf.org/doc/draft-ietf-oauth-status-list/) for more info.
Expand Down Expand Up @@ -67,7 +67,7 @@ To enable usage of principals at least one of the following keys must be provide

To load policy store one of the following keys must be provided:

* **`CEDARLING_LOCAL_POLICY_STORE`
* **`CEDARLING_POLICY_STORE_LOCAL`
* **`CEDARLING_POLICY_STORE_URI`
* **`CEDARLING_POLICY_STORE_LOCAL_FN`

Expand Down Expand Up @@ -229,7 +229,7 @@ Below is an example of a bootstrap config in JSON format. Not all fields should
"CEDARLING_USER_AUTHZ": "enabled",
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_POLICY_STORE_URI": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": "./example_files/policy-store.json",
"CEDARLING_TOKEN_CONFIGS": {
"access_token": {
Expand Down Expand Up @@ -300,7 +300,7 @@ CEDARLING_APPLICATION_NAME: My App
CEDARLING_USER_AUTHZ: enabled
CEDARLING_WORKLOAD_AUTHZ: enabled
CEDARLING_POLICY_STORE_URI: null
CEDARLING_LOCAL_POLICY_STORE: null
CEDARLING_POLICY_STORE_LOCAL: null
CEDARLING_POLICY_STORE_LOCAL_FN: ./example_files/policy-store.json
CEDARLING_TOKEN_CONFIGS:
access_token: { entity_type_name: "Access_token" }
Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/bindings/cedarling_python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ This project uses `maturin` to create a Python library from Rust code. Follow th
To verify that the library works correctly, you can run the provided `example.py` script. Make sure the virtual environment is activated before running the script:

```bash
CEDARLING_LOCAL_POLICY_STORE=example_files/policy-store.json python example.py
CEDARLING_POLICY_STORE_LOCAL=example_files/policy-store.json python example.py
```

## Building the Python Library
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION": "AND",
"CEDARLING_LOCAL_JWKS": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": "./example_files/policy-store.json",
"CEDARLING_JWT_SIG_VALIDATION": "disabled",
"CEDARLING_JWT_STATUS_VALIDATION": "disabled",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CEDARLING_APPLICATION_NAME: My App
CEDARLING_USER_AUTHZ: enabled
CEDARLING_WORKLOAD_AUTHZ: enabled
CEDARLING_POLICY_STORE_URI: null
CEDARLING_LOCAL_POLICY_STORE: null
CEDARLING_POLICY_STORE_LOCAL: null
CEDARLING_POLICY_STORE_LOCAL_FN: ./example_files/policy-store.json
CEDARLING_TOKEN_CONFIGS:
access_token: { entity_type_name: "Access_token" }
Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/bindings/cedarling_wasm/example_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const BOOTSTRAP_CONFIG = {
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION": "AND",
"CEDARLING_LOCAL_JWKS": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": null,
"CEDARLING_JWT_SIG_VALIDATION": "disabled",
"CEDARLING_JWT_STATUS_VALIDATION": "disabled",
Expand Down
4 changes: 2 additions & 2 deletions jans-cedarling/bindings/cedarling_wasm/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ static POLICY_STORE_RAW_YAML: &str =
static BOOTSTRAP_CONFIG: LazyLock<serde_json::Value> = LazyLock::new(|| {
json!({
"CEDARLING_APPLICATION_NAME": "My App",
"CEDARLING_LOCAL_POLICY_STORE": POLICY_STORE_RAW_YAML,
"CEDARLING_POLICY_STORE_LOCAL": POLICY_STORE_RAW_YAML,
"CEDARLING_LOG_TYPE": "std_out",
"CEDARLING_LOG_LEVEL": "INFO",
"CEDARLING_USER_AUTHZ": "enabled",
Expand Down Expand Up @@ -262,7 +262,7 @@ async fn test_run_cedarling() {
async fn test_memory_log_interface() {
let bootstrap_config_json = json!({
"CEDARLING_APPLICATION_NAME": "My App",
"CEDARLING_LOCAL_POLICY_STORE": POLICY_STORE_RAW_YAML,
"CEDARLING_POLICY_STORE_LOCAL": POLICY_STORE_RAW_YAML,
"CEDARLING_LOG_TYPE": "memory",
"CEDARLING_LOG_TTL": 120,
"CEDARLING_LOG_LEVEL": "INFO",
Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/cedarling/src/bootstrap_config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ pub enum BootstrapConfigLoadingError {
/// Error returned when multiple policy store sources were provided.
#[error(
"Multiple store options were provided. Make sure you only one of these properties is set: \
`CEDARLING_POLICY_STORE_URI` or `CEDARLING_LOCAL_POLICY_STORE`"
`CEDARLING_POLICY_STORE_URI` or `CEDARLING_POLICY_STORE_LOCAL`"
)]
ConflictingPolicyStores,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ pub struct BootstrapConfigRaw {
pub local_jwks: Option<String>,

/// JSON object with policy store
#[serde(rename = "CEDARLING_LOCAL_POLICY_STORE", default)]
#[serde(rename = "CEDARLING_POLICY_STORE_LOCAL", default)]
#[serde(deserialize_with = "deserialize_or_parse_string_as_json")]
pub local_policy_store: Option<String>,

Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/flask-sidecar/secrets/bootstrap.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION": "AND",
"CEDARLING_LOCAL_JWKS": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": null,
"CEDARLING_JWT_SIG_VALIDATION": "disabled",
"CEDARLING_JWT_STATUS_VALIDATION": "disabled",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION": "AND",
"CEDARLING_LOCAL_JWKS": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": null,
"CEDARLING_JWT_SIG_VALIDATION": "disabled",
"CEDARLING_JWT_STATUS_VALIDATION": "disabled",
Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/test_files/bootstrap_props.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"CEDARLING_WORKLOAD_AUTHZ": "enabled",
"CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION": "AND",
"CEDARLING_LOCAL_JWKS": null,
"CEDARLING_LOCAL_POLICY_STORE": null,
"CEDARLING_POLICY_STORE_LOCAL": null,
"CEDARLING_POLICY_STORE_LOCAL_FN": "../test_files/policy-store_blobby.json",
"CEDARLING_JWT_SIG_VALIDATION": "enabled",
"CEDARLING_JWT_STATUS_VALIDATION": "disabled",
Expand Down
2 changes: 1 addition & 1 deletion jans-cedarling/test_files/bootstrap_props.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CEDARLING_USER_AUTHZ: 'enabled'
CEDARLING_WORKLOAD_AUTHZ: 'enabled'
CEDARLING_USER_WORKLOAD_BOOLEAN_OPERATION: 'AND'
CEDARLING_LOCAL_JWKS: null
CEDARLING_LOCAL_POLICY_STORE: null
CEDARLING_POLICY_STORE_LOCAL: null
CEDARLING_POLICY_STORE_LOCAL_FN: '../test_files/policy-store_blobby.json'
CEDARLING_JWT_SIG_VALIDATION: 'enabled'
CEDARLING_JWT_STATUS_VALIDATION: 'disabled'
Expand Down

0 comments on commit 897ff29

Please sign in to comment.