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.

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

Unknown files in mark folder #204

Open
shahrzadav opened this issue Jun 1, 2021 · 1 comment
Open

Unknown files in mark folder #204

shahrzadav opened this issue Jun 1, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@shahrzadav
Copy link

In the mark folder of this repository, there are some files as RulesTR_.mark or RulesTR_.txt, which there is no explanation for them on the Codyze documentation page. I think they actually specify the correct usage of the APIs. However, there is no description of how they were created. It would be nice if you introduce them and explain them briefly on the documentation page.

@fwendland fwendland added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 8, 2021
@fwendland fwendland self-assigned this Jun 8, 2021
@fwendland fwendland added this to the 2.0.0 milestone Jun 15, 2021
@fwendland
Copy link
Collaborator

Hi @shahrzadav,

Files named RulesTR_*.mark contain MARK rules. We specified MARK entities and rules separately for Bouncy Castle. Hence, you'll find MARK files that just contain entities and other containing the rules.

Files named RulesTR_*.txt are placeholders. When we created MARK rules validating BSI TR-02102-1 for Bouncy Castle, we had a few requirements that were already covered by other rules. Some requirements were also not directly verifiable. To prevent problems when parsing *.mark files we simply called them *.txt.

I'll use this issue to check the documentation again and improve it.

@fwendland fwendland removed this from the 2.x.y milestone Dec 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants