Aleksander Morgado
0850fe4f6d
All the previous filter rules were applicable per-port independently. But, we also want to apply rules on a port based on the existence of other ports on the same device (e.g. allow TTY if the device also has a NET port). In this case, we need to wait for all ports to appear and then apply the additional rules. We re-use the "min wait time" timeout in the plugin-manager for this same purpose. This timeout is setup to wait for ports to appear before starting the probing process (e.g. so that plugin filters like the forbidden-drivers one work). The very same timeout can therefore be used to check whether we start the probing or not based on additional filter rules.
138 lines
5.5 KiB
C
138 lines
5.5 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details:
|
|
*
|
|
* Copyright (C) 2017 Aleksander Morgado <aleksander@aleksander.es>
|
|
*/
|
|
|
|
#ifndef MM_FILTER_H
|
|
#define MM_FILTER_H
|
|
|
|
#include <glib-object.h>
|
|
#include <gio/gio.h>
|
|
|
|
#include "mm-device.h"
|
|
#include "mm-kernel-device.h"
|
|
|
|
#define MM_TYPE_FILTER (mm_filter_get_type ())
|
|
#define MM_FILTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_FILTER, MMFilter))
|
|
#define MM_FILTER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_FILTER, MMFilterClass))
|
|
#define MM_IS_FILTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_FILTER))
|
|
#define MM_IS_FILTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), MM_TYPE_FILTER))
|
|
#define MM_FILTER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_FILTER, MMFilterClass))
|
|
|
|
#define MM_FILTER_ENABLED_RULES "enabled-rules" /* construct-only */
|
|
|
|
typedef struct _MMFilterPrivate MMFilterPrivate;
|
|
|
|
typedef struct {
|
|
GObject parent;
|
|
MMFilterPrivate *priv;
|
|
} MMFilter;
|
|
|
|
typedef struct {
|
|
GObjectClass parent;
|
|
} MMFilterClass;
|
|
|
|
GType mm_filter_get_type (void);
|
|
|
|
typedef enum { /*< underscore_name=mm_filter_rule >*/
|
|
MM_FILTER_RULE_NONE = 0,
|
|
MM_FILTER_RULE_EXPLICIT_WHITELIST = 1 << 0,
|
|
MM_FILTER_RULE_VIRTUAL = 1 << 1,
|
|
MM_FILTER_RULE_NET = 1 << 2,
|
|
MM_FILTER_RULE_CDC_WDM = 1 << 3,
|
|
MM_FILTER_RULE_TTY = 1 << 4,
|
|
MM_FILTER_RULE_TTY_BLACKLIST = 1 << 5,
|
|
MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY = 1 << 6,
|
|
MM_FILTER_RULE_TTY_PLATFORM_DRIVER = 1 << 7,
|
|
MM_FILTER_RULE_TTY_DEFAULT_ALLOWED = 1 << 8,
|
|
MM_FILTER_RULE_TTY_DRIVER = 1 << 9,
|
|
MM_FILTER_RULE_TTY_ACM_INTERFACE = 1 << 10,
|
|
MM_FILTER_RULE_TTY_WITH_NET = 1 << 11,
|
|
MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN = 1 << 12,
|
|
} MMFilterRule;
|
|
|
|
#define MM_FILTER_RULE_ALL \
|
|
(MM_FILTER_RULE_EXPLICIT_WHITELIST | \
|
|
MM_FILTER_RULE_VIRTUAL | \
|
|
MM_FILTER_RULE_NET | \
|
|
MM_FILTER_RULE_CDC_WDM | \
|
|
MM_FILTER_RULE_TTY | \
|
|
MM_FILTER_RULE_TTY_BLACKLIST | \
|
|
MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY | \
|
|
MM_FILTER_RULE_TTY_PLATFORM_DRIVER | \
|
|
MM_FILTER_RULE_TTY_DEFAULT_ALLOWED | \
|
|
MM_FILTER_RULE_TTY_DRIVER | \
|
|
MM_FILTER_RULE_TTY_ACM_INTERFACE | \
|
|
MM_FILTER_RULE_TTY_WITH_NET | \
|
|
MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN)
|
|
|
|
/* This is the default ModemManager policy that tries to automatically probe
|
|
* device ports unless they're blacklisted in some way or another. */
|
|
#define MM_FILTER_POLICY_DEFAULT \
|
|
(MM_FILTER_RULE_EXPLICIT_WHITELIST | \
|
|
MM_FILTER_RULE_VIRTUAL | \
|
|
MM_FILTER_RULE_NET | \
|
|
MM_FILTER_RULE_CDC_WDM | \
|
|
MM_FILTER_RULE_TTY | \
|
|
MM_FILTER_RULE_TTY_BLACKLIST | \
|
|
MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY | \
|
|
MM_FILTER_RULE_TTY_PLATFORM_DRIVER | \
|
|
MM_FILTER_RULE_TTY_DEFAULT_ALLOWED)
|
|
|
|
/* This is a stricter policy which will only automatically probe device ports
|
|
* if they are allowed by any of the automatic whitelist rules. */
|
|
#define MM_FILTER_POLICY_STRICT \
|
|
(MM_FILTER_RULE_EXPLICIT_WHITELIST | \
|
|
MM_FILTER_RULE_VIRTUAL | \
|
|
MM_FILTER_RULE_NET | \
|
|
MM_FILTER_RULE_CDC_WDM | \
|
|
MM_FILTER_RULE_TTY | \
|
|
MM_FILTER_RULE_TTY_PLATFORM_DRIVER | \
|
|
MM_FILTER_RULE_TTY_DRIVER | \
|
|
MM_FILTER_RULE_TTY_ACM_INTERFACE | \
|
|
MM_FILTER_RULE_TTY_WITH_NET | \
|
|
MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN)
|
|
|
|
/* This is equivalent to the strict policy, but also applying the device
|
|
* blacklists explicitly */
|
|
#define MM_FILTER_POLICY_PARANOID \
|
|
(MM_FILTER_RULE_EXPLICIT_WHITELIST | \
|
|
MM_FILTER_RULE_VIRTUAL | \
|
|
MM_FILTER_RULE_NET | \
|
|
MM_FILTER_RULE_CDC_WDM | \
|
|
MM_FILTER_RULE_TTY | \
|
|
MM_FILTER_RULE_TTY_BLACKLIST | \
|
|
MM_FILTER_RULE_TTY_MANUAL_SCAN_ONLY | \
|
|
MM_FILTER_RULE_TTY_PLATFORM_DRIVER | \
|
|
MM_FILTER_RULE_TTY_DRIVER | \
|
|
MM_FILTER_RULE_TTY_ACM_INTERFACE | \
|
|
MM_FILTER_RULE_TTY_WITH_NET | \
|
|
MM_FILTER_RULE_TTY_DEFAULT_FORBIDDEN)
|
|
|
|
/* This policy only allows using device ports explicitly whitelisted via
|
|
* udev rules. i.e. ModemManager won't do any kind of automatic probing. */
|
|
#define MM_FILTER_POLICY_WHITELIST_ONLY MM_FILTER_RULE_EXPLICIT_WHITELIST
|
|
|
|
MMFilter *mm_filter_new (MMFilterRule enabled_rules,
|
|
GError **error);
|
|
|
|
gboolean mm_filter_port (MMFilter *self,
|
|
MMKernelDevice *port,
|
|
gboolean manual_scan);
|
|
|
|
gboolean mm_filter_device_and_port (MMFilter *self,
|
|
MMDevice *device,
|
|
MMKernelDevice *port);
|
|
|
|
#endif /* MM_FILTER_H */
|