Skip to content
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

✨ Add regex validators for Anoncreds models #3520

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

✨ Add regex validators for Anoncreds models #3520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e44552
:sparkles: Add validators for Anoncreds models
ff137 Feb 13, 2025
5574bf9
:art: Remove redundant f-formatting
ff137 Feb 13, 2025
ae57fbf
:bug: Regex groups need different names
ff137 Feb 13, 2025
ea139ce
:white_check_mark: Fix test and valid pattern
ff137 Feb 13, 2025
1674205
:art: Fix examples (I think)
ff137 Feb 13, 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
30 changes: 20 additions & 10 deletions acapy_agent/messaging/valid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,10 +467,10 @@ class IndyCredDefId(Regexp):
EXAMPLE = "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"
PATTERN = (
rf"^([{B58}]{{21,22}})" # issuer DID
f":3" # cred def id marker
f":CL" # sig alg
":3" # cred def id marker
":CL" # sig alg
rf":(([1-9][0-9]*)|([{B58}]{{21,22}}:2:.+:[0-9.]+))" # schema txn / id
f":(.+)?$" # tag
":(.+)?$" # tag
)

def __init__(self):
Expand All @@ -485,8 +485,11 @@ def __init__(self):
class AnoncredsCredDefId(Regexp):
"""Validate value against anoncreds credential definition identifier specification."""

EXAMPLE = "did:(method):3:CL:20:tag"
PATTERN = r"^(.+$)"
EXAMPLE = "did:method:example:3:CL:12:tag1"
PATTERN = (
Copy link
Contributor

@jamshale jamshale Feb 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a comment on the issue but I don't think we can use a pattern like this. The 3:CL:12 stuff is indy specific. For the cheqd and the upcoming webvh method these identifiers are much different and can be really almost anything. That's why I changed it to this. I meant to just match anything.

I think every pattern with at least have the did method at the beginning. So we could have a did:<any sting only letters>:<any string> pattern here.

Same with the other object id's.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, but a validator that matches anything is not really a validator :-)

If it must start with a qualified did, that's at least something. The pattern after that can be more random, but it assists in understanding the code. So I think it's worth sussing out the true restrictions on what the patterns are -- and then expanding those patterns later if we run into issues

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. But I remember the legacy indy(sov) method that still persists (try to change this), doesn't even have the did:sov part at the beginning.

I think I was lost on what to do for the validator and that's why I had it this way. Maybe not having a validator at all would be better for now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figure that's an option too. Skipping validation, just to save on regex compute and make the earth greener 😄

Of course it's much of a muchness, doing .+ regex check vs skipping it.
I figured it's at least worth marking this as a to-do, so that it's tracked as an unanswered question: what is the correct validation for anoncreds cred def / schema id / rev reg id. If we as a community can't answer that, then something's wrong 😄 if we're still dragging technical debt of needing to handle unqualified dids, maybe that should be prioritised

r"^did:(?P<method>[a-zA-Z0-9]+):(?P<did>[a-zA-Z0-9]+):3:"
r"CL:(?P<schema_id>\d+):(?P<tag>[a-zA-Z0-9_-]+)$"
)

def __init__(self):
"""Initialize the instance."""
Expand Down Expand Up @@ -530,8 +533,11 @@ def __init__(self):
class AnoncredsSchemaId(Regexp):
"""Validate value against indy schema identifier specification."""

EXAMPLE = "did:(method):2:schema_name:1.0"
PATTERN = r"^(.+$)"
EXAMPLE = "did:method:example:2:schema_name:1.0"
PATTERN = (
r"^did:(?P<method>[a-zA-Z0-9]+):(?P<did>[a-zA-Z0-9]+):2:"
r"(?P<schema_name>[a-zA-Z0-9_-]+):(?P<version>[0-9.]+)$"
)

def __init__(self):
"""Initialize the instance."""
Expand All @@ -550,7 +556,7 @@ class IndyRevRegId(Regexp):
rf"^([{B58}]{{21,22}}):4:"
rf"([{B58}]{{21,22}}):3:"
rf"CL:(([1-9][0-9]*)|([{B58}]{{21,22}}:2:.+:[0-9.]+))(:.+)?:"
rf"CL_ACCUM:(.+$)"
r"CL_ACCUM:(.+$)"
)

def __init__(self):
Expand All @@ -565,8 +571,12 @@ def __init__(self):
class AnoncredsRevRegId(Regexp):
"""Validate value against anoncreds revocation registry identifier specification."""

EXAMPLE = "did:(method):4:did:<method>:3:CL:20:tag:CL_ACCUM:0"
PATTERN = r"^(.+$)"
EXAMPLE = "did:method:example:4:did:method:example:3:CL:20:tag:CL_ACCUM:0"
PATTERN = (
r"^did:(?P<method1>[a-zA-Z0-9]+):(?P<did1>[a-zA-Z0-9]+):4:"
r"did:(?P<method2>[a-zA-Z0-9]+):(?P<did2>[a-zA-Z0-9]+):3:"
r"CL:(?P<schema_id>\d+):(?P<tag>[a-zA-Z0-9_-]+):CL_ACCUM:(.+)$"
)

def __init__(self):
"""Initialize the instance."""
Expand Down
2 changes: 1 addition & 1 deletion acapy_agent/protocols/issue_credential/v2_0/formats/anoncreds/tests/test_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
from ..handler import LOGGER as ANONCREDS_LOGGER
from ..handler import AnonCredsCredFormatHandler

TEST_DID = "LjgpST2rjsoxYegQDRm7EL"
TEST_DID = "did:sov:LjgpST2rjsoxYegQDRm7EL"
SCHEMA_NAME = "bc-reg"
SCHEMA_TXN = 12
SCHEMA_ID = f"{TEST_DID}:2:{SCHEMA_NAME}:1.0"
Expand Down
Loading