Skip to content

Remove legacy configuration options #752

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.

Sign up for GitHub

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

Merged
esune merged 2 commits into from
Apr 4, 2025
Merged

Remove legacy configuration options #752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2053c33
Remove OOB and URL config options
loneil Apr 3, 2025
e6f66c2
Add a unit test
loneil Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions charts/vc-authn-oidc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ kubectl delete secret,pvc --selector "app.kubernetes.io/instance"=my-release
| `acapyTenancyMode` | Agent tenancy mode, either `single` or `multi` | `single` |
| `setNonRevoked` | if True, the `non_revoked` attributed will be added to each of the present-proof request `requested_attribute` and `requested_predicate` with 'from=0' and'to=`int(time.time())` | `true` |
| `invitationLabel` | For the invitations sent that include the proof, what to add as the my_label field. Can be used to identify the requester to the prover | `VC-AuthN` |
| `useOobPresentProof` | if True, the present-proof request will be provided as a an [out of band](https://github.com/hyperledger/aries-rfcs/tree/main/features/0434-outofband) invitation with a [present-proof](https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof) request inside. If False, the present-proof request will be use the [service-decorator](https://github.com/hyperledger/aries-rfcs/tree/main/features/0056-service-decorator) | `false` |
| `useOobLocalDIDService` | | `false` |
| `useUrlDeepLink` | if True, will use the new encoded URL (e.g. bcwallet://aries_proof-request?_url={redirect URL}) redirect form of the deep link | `false` |
| `walletDeepLinkPrefix` | URI scheme and host to use in deep links ((e.g. `{WALLET_DEEP_LINK_PREFIX}?c_i={connection invitation payload`)) | `bcwallet://aries_proof-request` |
| `controller.cameraRedirectUrl` | The redirect url can be a web link or the name of a template | `wallet_howto` |
| `controller.presentationExpireTime` | The number of time in seconds a proof request will be valid for | `300` |
Expand Down
4 changes: 0 additions & 4 deletions charts/vc-authn-oidc/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,6 @@ spec:
value: {{ include "acapy.internal.admin.url" . }}
- name: INVITATION_LABEL
value: {{ .Values.invitationLabel | quote }}
- name: USE_OOB_PRESENT_PROOF
value: {{ .Values.useOobPresentProof | quote }}
- name: USE_URL_DEEP_LINK
value: {{ .Values.useUrlDeepLink | quote }}
- name: WALLET_DEEP_LINK_PREFIX
value: {{ .Values.walletDeepLinkPrefix }}
- name: SET_NON_REVOKED
Expand Down
4 changes: 0 additions & 4 deletions charts/vc-authn-oidc/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,8 @@ acapyTenancyMode: single
setNonRevoked: true
## @param invitationLabel For the invitations sent that include the proof, what to add as the my_label field. Can be used to identify the requester to the prover
invitationLabel: VC-AuthN
## @param useOobPresentProof if True, the present-proof request will be provided as a an [out of band](https://github.com/hyperledger/aries-rfcs/tree/main/features/0434-outofband) invitation with a [present-proof](https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof) request inside. If False, the present-proof request will be use the [service-decorator](https://github.com/hyperledger/aries-rfcs/tree/main/features/0056-service-decorator)
useOobPresentProof: false
## @param useOobLocalDIDService
useOobLocalDIDService: false
## @param useUrlDeepLink if True, will use the new encoded URL (e.g. bcwallet://aries_proof-request?_url={redirect URL}) redirect form of the deep link
useUrlDeepLink: false
## @param walletDeepLinkPrefix URI scheme and host to use in deep links ((e.g. `{WALLET_DEEP_LINK_PREFIX}?c_i={connection invitation payload`))
walletDeepLinkPrefix: bcwallet://aries_proof-request
## @param controller.cameraRedirectUrl The redirect url can be a web link or the name of a template
Expand Down
2 changes: 0 additions & 2 deletions docker/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ services:
- MT_ACAPY_WALLET_KEY=${MT_ACAPY_WALLET_KEY}
- ST_ACAPY_ADMIN_API_KEY=${AGENT_ADMIN_API_KEY}
- ST_ACAPY_ADMIN_API_KEY_NAME=${ST_ACAPY_ADMIN_API_KEY_NAME}
- USE_OOB_PRESENT_PROOF=${USE_OOB_PRESENT_PROOF}
- USE_OOB_LOCAL_DID_SERVICE=${USE_OOB_LOCAL_DID_SERVICE}
- USE_URL_DEEP_LINK=${USE_URL_DEEP_LINK}
- WALLET_DEEP_LINK_PREFIX=${WALLET_DEEP_LINK_PREFIX}
- INVITATION_LABEL=${INVITATION_LABEL}
ports:
Expand Down
2 changes: 0 additions & 2 deletions docker/manage
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,7 @@ configureEnvironment() {
#controller app settings
export INVITATION_LABEL=${INVITATION_LABEL:-"VC-AuthN"}
export SET_NON_REVOKED="True"
export USE_OOB_PRESENT_PROOF=${USE_OOB_PRESENT_PROOF:-"true"}
export USE_OOB_LOCAL_DID_SERVICE=${USE_OOB_LOCAL_DID_SERVICE:-"true"}
export USE_URL_DEEP_LINK=${USE_URL_DEEP_LINK:-"false"}
export WALLET_DEEP_LINK_PREFIX=${WALLET_DEEP_LINK_PREFIX:-"bcwallet://aries_proof-request"}

# agent
Expand Down
4 changes: 1 addition & 3 deletions docs/ConfigurationGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,7 @@ Several functions in ACAPy VC-AuthN can be tweaked by using the following enviro
| Variable | Type | What it does | NOTES |
| ------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| SET_NON_REVOKED | bool | if True, the `non_revoked` attributed will be added to each of the present-proof request `requested_attribute` and `requested_predicate` with 'from=0' and'to=`int(time.time())` | |
| USE_OOB_PRESENT_PROOF | bool | if True, the present-proof request will be provided as a an [out of band](https://github.com/hyperledger/aries-rfcs/tree/main/features/0434-outofband) invitation with a [present-proof](https://github.com/hyperledger/aries-rfcs/tree/main/features/0037-present-proof) request inside. If False, the present-proof request will be use the [service-decorator](https://github.com/hyperledger/aries-rfcs/tree/main/features/0056-service-decorator) | **TRUE:** BC Wallet supports our OOB Message, BiFold, Lissi, Trinsic, and Estatus all read the QR code as 'Invalid' |
| USE_OOB_LOCAL_DID_SERVICE | bool | Instructs ACAPy VC-AuthN to use a local DID, it must be used when the agent service is not registered on the ledger with a public DID | Use this when `ACAPY_WALLET_LOCAL_DID` is set to `true` in the agent. |
| USE_URL_DEEP_LINK | bool | If True, in Mobile mode the BC Wallet deep link will use an encoded URL (`WALLET_DEEP_LINK_PREFIX?_url={redirect URL}`), otherwise will use the encoded connection invitation (`{WALLET_DEEP_LINK_PREFIX}?c_i={connection invitation payload}`) | Default False/.. To control using the `?_url` handler |
| USE_OOB_LOCAL_DID_SERVICE | bool | Instructs ACAPy VC-AuthN to use a local DID, it must be used when the agent service is not registered on the ledger with a public DID | Use this when `ACAPY_WALLET_LOCAL_DID` is set to `true` in the agent. |
| WALLET_DEEP_LINK_PREFIX | string | Custom URI scheme and host to use for deep links (e.g. `{WALLET_DEEP_LINK_PREFIX}?c_i={connection invitation payload`) | Default bcwallet://aries_proof-request |
| LOG_WITH_JSON | bool | If True, logging output should printed as JSON if False it will be pretty printed. | Default behavior will print as JSON. |
| LOG_TIMESTAMP_FORMAT | string | determines the timestamp formatting used in logs | Default is "iso" |
Expand Down
4 changes: 0 additions & 4 deletions oidc-controller/api/core/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,9 @@ class GlobalConfig(BaseSettings):
# OIDC Controller Settings
INVITATION_LABEL: str = os.environ.get("INVITATION_LABEL", "VC-AuthN")
CONTROLLER_API_KEY: str = os.environ.get("CONTROLLER_API_KEY", "")
USE_OOB_PRESENT_PROOF: bool = strtobool(
os.environ.get("USE_OOB_PRESENT_PROOF", False)
)
USE_OOB_LOCAL_DID_SERVICE: bool = strtobool(
os.environ.get("USE_OOB_LOCAL_DID_SERVICE", True)
)
USE_URL_DEEP_LINK: bool = strtobool(os.environ.get("USE_URL_DEEP_LINK", False))
WALLET_DEEP_LINK_PREFIX: str = os.environ.get(
"WALLET_DEEP_LINK_PREFIX", "bcwallet://aries_proof-request"
)
Expand Down
18 changes: 18 additions & 0 deletions oidc-controller/api/core/tests/test_core_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import pytest
from api.core.config import strtobool


def test_strtobool():
# Test valid truthy values
truthy_values = ["y", "yes", "t", "true", "on", "1", True]
for value in truthy_values:
assert strtobool(value) is True

# Test valid falsy values
falsy_values = ["n", "no", "f", "false", "off", "0", False]
for value in falsy_values:
assert strtobool(value) is False

# Test invalid input
with pytest.raises(ValueError, match="invalid truth value invalid"):
strtobool("invalid")
Loading