mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-14 16:32:06 +01:00
Add README for hsregex module
This commit is contained in:
parent
8169db4bbd
commit
77c669d289
1 changed files with 18 additions and 0 deletions
18
hsregex/README.md
Normal file
18
hsregex/README.md
Normal 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());
|
||||
```
|
Loading…
Reference in a new issue