SymbX/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove LEGACY(DEFAULT) and PARANOID filter policy documentation

Browse Source
This commit is contained in:
Aleksander Morgado
2021-06-16 10:44:39 +02:00
parent 172b350871
commit 756f9c5e75
2 changed files with 6 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/man/ModemManager.8
+1 -7
View File
@@ -28,14 +28,8 @@ Specify which ports are probed and how:
\fB'WHITELIST-ONLY'\fR
Only devices or ports explicitly whitelisted with the 'ID_MM_DEVICE_PROCESS' udev tag are probed.
.TP
\fB'DEFAULT'\fR
All ports are allowed to be probed except for the ones explicitly greylisted as RS232 adapters or completely blacklisted.
.TP
\fB'STRICT'\fR
Only the TTY ports that are heurstically determined to be very likely to be modem ports are probed. Nay end up ignoring some devices.
.TP
\fB'PARANOID'\fR
This is equivalent to running the STRICT mode but also applying the blacklist and RS232 greylist filters explicitly.
Only the TTY ports that are heuristically determined to be very likely to be modem ports are probed. Nay end up ignoring some devices.
.RE
.TP
.B \-\-no\-auto\-scan
docs/reference/api/ModemManager-overview.xml
+5 -63
View File
@@ -245,32 +245,6 @@ $ sudo udevadm trigger
</para>
<programlisting># /usr/sbin/ModemManager --filter-policy=WHITELIST-ONLY</programlisting>
</listitem>
<listitem>
<para><emphasis>Default</emphasis></para>
<para>
This is a policy where the following rules are enabled:
<itemizedlist>
<listitem>MM_FILTER_RULE_EXPLICIT_WHITELIST</listitem>
<listitem>MM_FILTER_RULE_EXPLICIT_BLACKLIST</listitem>
<listitem>MM_FILTER_RULE_VIRTUAL</listitem>
<listitem>MM_FILTER_RULE_NET</listitem>
<listitem>MM_FILTER_RULE_USBMISC</listitem>
<listitem>MM_FILTER_RULE_TTY</listitem>
<listitem>MM_FILTER_RULE_TTY_BLACKLIST</listitem>
<listitem>MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY</listitem>
<listitem>MM_FILTER_RULE_TTY_PLATFORM_DRIVER</listitem>
<listitem>MM_FILTER_RULE_TTY_DEFAULT_ALLOWED</listitem>
</itemizedlist>
</para>
<para>
This policy is the default one when a different one not explicitly
selected, and is equivalent to the way ModemManager has worked in previous
releases. This policy is the least restrictive one, and will end up
allowing port probing of all TTYs not explicitly blacklisted in one way
or another.
</para>
<programlisting># /usr/sbin/ModemManager --filter-policy=DEFAULT</programlisting>
</listitem>
<listitem>
<para><emphasis>Strict</emphasis></para>
<para>
@@ -290,44 +264,12 @@ $ sudo udevadm trigger
</itemizedlist>
</para>
<para>
This policy is stricter than the default one, as by default all TTYs are
forbidden except for the ones explicitly allowed by one of the TTY-specific
rules. Distributions or users should use this policy if they don't want
ModemManager to mess around with TTY ports that may not be exposed by
actual modems.
This policy is the default one when a different one is not explicitly
selected. In this policy, all TTYs are forbidden except for the ones
explicitly allowed by one of the TTY-specific rules.
</para>
<programlisting># /usr/sbin/ModemManager --filter-policy=STRICT</programlisting>
</listitem>
<listitem>
<para><emphasis>Paranoid</emphasis></para>
<para>
This policy is a mix of the Default and Strict ones:
<itemizedlist>
<listitem>MM_FILTER_RULE_EXPLICIT_WHITELIST</listitem>
<listitem>MM_FILTER_RULE_EXPLICIT_BLACKLIST</listitem>
<listitem>MM_FILTER_RULE_VIRTUAL</listitem>
<listitem>MM_FILTER_RULE_NET</listitem>
<listitem>MM_FILTER_RULE_USBMISC</listitem>
<listitem>MM_FILTER_RULE_TTY</listitem>
<listitem>MM_FILTER_RULE_TTY_BLACKLIST</listitem>
<listitem>MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY</listitem>
<listitem>MM_FILTER_RULE_TTY_PLATFORM_DRIVER</listitem>
<listitem>MM_FILTER_RULE_TTY_DRIVER</listitem>
<listitem>MM_FILTER_RULE_TTY_ACM_INTERFACE</listitem>
<listitem>MM_FILTER_RULE_TTY_WITH_NET</listitem>
<listitem>MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN</listitem>
</itemizedlist>
</para>
<para>
This policy is equivalent to the Strict policy, but where the ModemManager
provided blacklist and manual scan only greylist are also used. It is not
recommended to use this option in normal setups as the blacklists may be
obsoleted in future ModemManager versions (in favor of using the Strict
policy as default).
</para>
<programlisting># /usr/sbin/ModemManager --filter-policy=PARANOID</programlisting>
</listitem>
<listitem>
<para><emphasis>Custom</emphasis></para>
<para>
@@ -335,12 +277,12 @@ $ sudo udevadm trigger
by explicitly enabling or disabling rules via environment variables.
</para>
<para>
E.g. this would launch ModemManager with the Default filter policy but with all
E.g. this would launch ModemManager with the Strict filter policy but with all
net and cdc-wdm ports forbidden completely:
<programlisting>
# MM_FILTER_RULE_NET=0 \
MM_FILTER_RULE_USBMISC=0 \
/usr/sbin/ModemManager --filter-policy=DEFAULT</programlisting>
/usr/sbin/ModemManager --filter-policy=STRICT</programlisting>
</para>
<para>
E.g. this would launch ModemManager with the Whitelist-only filter policy but also