Skip to content

Fix and factor out the SNMPv3 security parameter descriptions #5228

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
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix and factor out the SNMPv3 security parameter descriptions #5228

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
23 changes: 23 additions & 0 deletions language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2066,6 +2066,29 @@ while <constant>PGSQL_BOTH</constant> will return both numerical and associative
</entry>
</row>'>

<!-- SNMP entities -->

<!ENTITY snmp.changelog.auth-protocol-sha2 '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.1.0</entry>
<entry>
The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
and <literal>"SHA512"</literal> when supported by libnetsnmp.
</entry>
</row>'>

<!ENTITY snmp.parameter.security-name '<simpara xmlns="http://docbook.org/ns/docbook">the security name, usually some kind of username</simpara>'>

<!ENTITY snmp.parameter.security-level '<simpara xmlns="http://docbook.org/ns/docbook">the security level (noAuthNoPriv|authNoPriv|authPriv)</simpara>'>

<!ENTITY snmp.parameter.auth-protocol '<simpara xmlns="http://docbook.org/ns/docbook">the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)</simpara>'>

<!ENTITY snmp.parameter.auth-passphrase '<simpara xmlns="http://docbook.org/ns/docbook">the authentication pass phrase</simpara>'>

<!ENTITY snmp.parameter.privacy-protocol '<simpara xmlns="http://docbook.org/ns/docbook">the privacy protocol (DES or AES)</simpara>'>

<!ENTITY snmp.parameter.privacy-passphrase '<simpara xmlns="http://docbook.org/ns/docbook">the privacy pass phrase</simpara>'>

<!-- Common pieces for reference part END -->

<!ENTITY windows.builtin '<simpara xmlns="http://docbook.org/ns/docbook">The Windows version of PHP has built-in
Expand Down
33 changes: 7 additions & 26 deletions reference/snmp/functions/snmp3-get.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,50 +42,37 @@
<varlistentry>
<term><parameter>security_name</parameter></term>
<listitem>
<simpara>
the security name, usually some kind of username
</simpara>
&snmp.parameter.security-name;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_level</parameter></term>
<listitem>
<simpara>
the security level (noAuthNoPriv|authNoPriv|authPriv)
</simpara>
&snmp.parameter.security-level;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_protocol</parameter></term>
<listitem>
<simpara>
the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)
</simpara>
&snmp.parameter.auth-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_passphrase</parameter></term>
<listitem>
<simpara>
the authentication pass phrase
</simpara>
&snmp.parameter.auth-passphrase;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_protocol</parameter></term>
<listitem>
<simpara>
the privacy protocol (DES or AES)
</simpara>
&snmp.parameter.privacy-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_passphrase</parameter></term>
<listitem>
<simpara>
the privacy pass phrase
</simpara>
&snmp.parameter.privacy-passphrase;
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -142,13 +129,7 @@
are lower than -1 or too large.
</entry>
</row>
<row>
<entry>8.1.0</entry>
<entry>
The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
and <literal>"SHA512"</literal> when supported by libnetsnmp.
</entry>
</row>
&snmp.changelog.auth-protocol-sha2;
</tbody>
</tgroup>
</informaltable>
Expand Down
33 changes: 7 additions & 26 deletions reference/snmp/functions/snmp3-getnext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,50 +43,37 @@
<varlistentry>
<term><parameter>security_name</parameter></term>
<listitem>
<simpara>
the security name, usually some kind of username
</simpara>
&snmp.parameter.security-name;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_level</parameter></term>
<listitem>
<simpara>
the security level (noAuthNoPriv|authNoPriv|authPriv)
</simpara>
&snmp.parameter.security-level;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_protocol</parameter></term>
<listitem>
<simpara>
the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)
</simpara>
&snmp.parameter.auth-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_passphrase</parameter></term>
<listitem>
<simpara>
the authentication pass phrase
</simpara>
&snmp.parameter.auth-passphrase;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_protocol</parameter></term>
<listitem>
<simpara>
the privacy protocol (DES or AES)
</simpara>
&snmp.parameter.privacy-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_passphrase</parameter></term>
<listitem>
<simpara>
the privacy pass phrase
</simpara>
&snmp.parameter.privacy-passphrase;
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -135,13 +122,7 @@
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
and <literal>"SHA512"</literal> when supported by libnetsnmp.
</entry>
</row>
&snmp.changelog.auth-protocol-sha2;
</tbody>
</tgroup>
</informaltable>
Expand Down
33 changes: 7 additions & 26 deletions reference/snmp/functions/snmp3-real-walk.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,60 +50,47 @@
<parameter>security_name</parameter>
</term>
<listitem>
<simpara>
the security name, usually some kind of username
</simpara>
&snmp.parameter.security-name;
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>security_level</parameter>
</term>
<listitem>
<simpara>
the security level (noAuthNoPriv|authNoPriv|authPriv)
</simpara>
&snmp.parameter.security-level;
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>auth_protocol</parameter>
</term>
<listitem>
<simpara>
the authentication protocol (MD5 or SHA)
</simpara>
&snmp.parameter.auth-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>auth_passphrase</parameter>
</term>
<listitem>
<simpara>
the authentication pass phrase
</simpara>
&snmp.parameter.auth-passphrase;
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>privacy_protocol</parameter>
</term>
<listitem>
<simpara>
the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)
</simpara>
&snmp.parameter.privacy-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>privacy_passphrase</parameter>
</term>
<listitem>
<simpara>
the privacy pass phrase
</simpara>
&snmp.parameter.privacy-passphrase;
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -159,13 +146,7 @@
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
and <literal>"SHA512"</literal> when supported by libnetsnmp.
</entry>
</row>
&snmp.changelog.auth-protocol-sha2;
</tbody>
</tgroup>
</informaltable>
Expand Down
25 changes: 7 additions & 18 deletions reference/snmp/functions/snmp3-set.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,49 +47,37 @@
<varlistentry>
<term><parameter>security_name</parameter></term>
<listitem>
<simpara>
the security name, usually some kind of username
</simpara>
&snmp.parameter.security-name;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_level</parameter></term>
<listitem>
<simpara>
the security level (noAuthNoPriv|authNoPriv|authPriv)
</simpara>
&snmp.parameter.security-level;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_protocol</parameter></term>
<listitem>
<simpara>
the authentication protocol (MD5 or SHA)
</simpara>
&snmp.parameter.auth-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_passphrase</parameter></term>
<listitem>
<simpara>
the authentication pass phrase
</simpara>
&snmp.parameter.auth-passphrase;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_protocol</parameter></term>
<listitem>
<simpara>
the privacy protocol (DES or AES)
</simpara>
&snmp.parameter.privacy-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_passphrase</parameter></term>
<listitem>
<simpara>
the privacy pass phrase
</simpara>
&snmp.parameter.privacy-passphrase;
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -167,6 +155,7 @@
are lower than -1 or too large.
</entry>
</row>
&snmp.changelog.auth-protocol-sha2;
</tbody>
</tgroup>
</informaltable>
Expand Down
33 changes: 7 additions & 26 deletions reference/snmp/functions/snmp3-walk.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,50 +44,37 @@
<varlistentry>
<term><parameter>security_name</parameter></term>
<listitem>
<simpara>
the security name, usually some kind of username
</simpara>
&snmp.parameter.security-name;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>security_level</parameter></term>
<listitem>
<simpara>
the security level (noAuthNoPriv|authNoPriv|authPriv)
</simpara>
&snmp.parameter.security-level;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_protocol</parameter></term>
<listitem>
<simpara>
the authentication protocol (<literal>"MD5"</literal>, <literal>"SHA"</literal>,
<literal>"SHA256"</literal>, or <literal>"SHA512"</literal>)
</simpara>
&snmp.parameter.auth-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>auth_passphrase</parameter></term>
<listitem>
<simpara>
the authentication pass phrase
</simpara>
&snmp.parameter.auth-passphrase;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_protocol</parameter></term>
<listitem>
<simpara>
the privacy protocol (DES or AES)
</simpara>
&snmp.parameter.privacy-protocol;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privacy_passphrase</parameter></term>
<listitem>
<simpara>
the privacy pass phrase
</simpara>
&snmp.parameter.privacy-passphrase;
</listitem>
</varlistentry>
<varlistentry>
Expand Down Expand Up @@ -143,13 +130,7 @@
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
The <parameter>auth_protocol</parameter> now accepts <literal>"SHA256"</literal>
and <literal>"SHA512"</literal> when supported by libnetsnmp.
</entry>
</row>
&snmp.changelog.auth-protocol-sha2;
</tbody>
</tgroup>
</informaltable>
Expand Down
Loading