PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-22 20:32:05 +01:00
Code Issues Releases Wiki Activity

Add README for hsregex module

Browse source
This commit is contained in:
Paul Schaub 2022-11-30 17:01:21 +01:00
parent 8169db4bbd
commit 77c669d289
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
hsregex/README.md Normal file
View file

@ -0,0 +1,18 @@
<!--
SPDX-FileCopyrightText: 2022 Paul Schaub <vanitasvitae@fsfe.org>
SPDX-License-Identifier: Apache-2.0
-->
# Evaluate Regular Expressions in OpenPGP Signatures using TCL-Regex
RFC4880 specifies contains a section about RegularExpression subpackets on signatures.
Within this section, the syntax of the RegularExpression subpackets is defined to be the same as Henry Spencer's "almost public domain" regular expression package.
Since Java's `java.util.regex` syntax is too powerful, this module exists to implement regex evaluation using [tcl-regex](https://github.com/basis-technology-corp/tcl-regex-java)
which appears to be a Java port of Henry Spencers regex package.
To make use of this implementation, simply call
```java
RegexInterpreterFactory.setInstance(new HSRegexInterpreterFactory());
```