Skip to content

User & Product Guide updates reflecting v1.1.0 changes in BSL #20

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

Open
jeronstone wants to merge 3 commits into
base: main
Choose a base branch
from
Open

User & Product Guide updates reflecting v1.1.0 changes in BSL #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffa2c9f
init
jeronstone Sep 17, 2025
c30e143
mend
jeronstone Sep 17, 2025
196a9af
add loc to user guide
jeronstone Sep 22, 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: 1 addition & 1 deletion product-guide/manual.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ sudo dnf install -y epel-release
sudo crb enable
sudo dnf install -y \
rsync cmake git ninja-build gcc ruby \
openssl-devel jansson-devel \
openssl-devel jansson-devel valgrind-devel \
doxygen graphviz plantuml texlive-bibtex \
asciidoctor \
rpm-build rpmlint
Expand Down
9 changes: 6 additions & 3 deletions user-guide/manual.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,9 +368,6 @@ digraph figure {
}
----

==== EID CBOR CODEC Callback Limitation
The dynamic backend calls host callback functions `eid_to_cbor` and `eid_from_cbor` with QCBOR contexts. Thus, BPAs **must** use QCBOR to append data to the context passed to these callback functions when using the dynamic backend. Future versions of BSL will remove this limitation.

[#sec-api]
== API Overview

Expand Down Expand Up @@ -463,6 +460,9 @@ Each file's JSON encoding must have the attribute `policyrule_set`, which contai
`key_wrap`::
An extra security context parameter id `key_wrap` will be parsed. When the value is set to "0", key wrapping will be skipped. For all other values, key wrapping will be enabled. Decision to key wrap is a required parameter for security operations when executed within the implementations of the Default Security Contexts.

`loc`::
An attribute of `filter` that specifies the interaction point (APPIN, APPOUT, CLIN, CLOUT) where the policy rule should be applied.

===== Example JSON-Encoded Policy Provider
An example with two policy rules is as follows:

Expand Down Expand Up @@ -491,6 +491,9 @@ The default initialization vector length as specified by <<RFC9173>>.
`BSLP_POLICYPREDICATE_ARRAY_CAPACITY` = 100::
Maximum number of policy rules and policy predicates a policy provider may hold. In future BSL versions, the number of policy rules will not be limited, and this value will be removed.

`POLICY_RULE_DESCRIPTION_MAX_STRLEN` = 100::
Maximum length of sample policy provider rule description. When initializing a policy rule, only characters at position `0` through `POLICY_RULE_DESCRIPTION_MAX_STRLEN-1` are copied from the source string buffer.

`MOCK_BPA_MAX_POLICIES` = 100::
The maximum number of policies a Mock BPA registry may hold. In future BSL versions, the number of policies will not be limited, and this value will be removed.

Expand Down