Skip to content

Provide security settings model documentation #89

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

Merged
merged 1 commit into from
Jan 28, 2025
Merged

Provide security settings model documentation #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<version>4.0.4-SNAPSHOT</version>

<name>Plexus Security Dispatcher Component</name>
<description>This library provides encryption/decryption functionality with pluggable ciphers and password providers</description>

<scm>
<connection>scm:git:[email protected]:codehaus-plexus/plexus-sec-dispatcher.git</connection>
Expand Down Expand Up @@ -98,6 +99,13 @@
<goal>stax-writer</goal>
</goals>
</execution>
<execution>
<id>generate-xdoc</id>
<goals>
<goal>xdoc</goal>
</goals>
<phase>pre-site</phase>
</execution>
</executions>
</plugin>
<plugin>
Expand Down
7 changes: 4 additions & 3 deletions src/main/mdo/settings-security.mdo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

<id>settings-security</id>
<name>SecurityConfiguration</name>
<description>SecurityConfiguration</description>
<description>The security configuration contains all settings related to the encryption/decryption functionality</description>

<defaults>
<default>
Expand All @@ -32,13 +32,14 @@
<classes>
<class rootElement="true">
<name>SettingsSecurity</name>
<description>Root element containing all security settings.</description>
<version>1.0.0+</version>
<fields>
<field>
<name>master</name>
<version>1.0.0/2.1.0</version>
<type>String</type>
<description>encrypted master password</description>
<description>Encrypted master password.</description>
</field>
<field>
<name>relocation</name>
Expand All @@ -52,7 +53,7 @@
<version>3.0.0+</version>
<type>String</type>
<required>true</required>
<description>The version of the model</description>
<description>The version of the model, use '4.0' for the most recent one.</description>
</field>
<field>
<name>masterSource</name>
Expand Down
8 changes: 8 additions & 0 deletions src/site/site.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
<body>
<menu name="Overview">
<item name="Settings" href="settings-security.html"/>
</menu>
</body>
</site>
Loading