Struct adblock::resources::PermissionMask

pub struct PermissionMask(/* private fields */);

Specifies a set of permissions required to inject a scriptlet resource.

Permissions can be specified when parsing individual lists using crate::FilterSet in order to propagate the permission level to all filters contained in the list.

In practice, permissions are used to limit the risk of third-party lists having access to powerful scriptlets like uBlock Origin’s trusted-set-cookie, which has the ability to set arbitrary cookies to arbitrary values on visited sites.

Example

const COOKIE_ACCESS: PermissionMask = PermissionMask::from_bits(0b00000001);
const LOCALSTORAGE_ACCESS: PermissionMask = PermissionMask::from_bits(0b00000010);

// `untrusted_filters` will not be able to use privileged scriptlet injections.
filter_set.add_filters(
    untrusted_filters,
    Default::default(),
);
// `trusted_filters` will be able to inject scriptlets requiring `COOKIE_ACCESS`
// permissions or `LOCALSTORAGE_ACCESS` permissions.
filter_set.add_filters(
    trusted_filters,
    ParseOptions {
        permissions: COOKIE_ACCESS | LOCALSTORAGE_ACCESS,
        ..Default::default()
    },
);

let mut engine = Engine::from_filter_set(filter_set, true);
// The `trusted-set-cookie` scriptlet cannot be injected without `COOKIE_ACCESS`
// permission.
engine.add_resource(Resource {
    name: "trusted-set-cookie.js".to_string(),
    aliases: vec![],
    kind: ResourceType::Mime(MimeType::ApplicationJavascript),
    content: base64::encode("document.cookie = '...';"),
    dependencies: vec![],
    permission: COOKIE_ACCESS,
});

Implementations

impl PermissionMask

pub const fn from_bits(bits: u8) -> Self

Construct a new PermissionMask with the given bitmask. Use PermissionMask::default() instead if you don’t want to restrict or grant any permissions.

pub fn is_injectable_by(&self, filter_mask: PermissionMask) -> bool

Can filter_mask authorize injecting a resource requiring self permissions?

Trait Implementations

impl BitOr for PermissionMask

type Output = PermissionMask

The resulting type after applying the | operator.

fn bitor(self, rhs: PermissionMask) -> Self::Output

Performs the | operation.

impl BitOrAssign for PermissionMask

fn bitor_assign(&mut self, rhs: PermissionMask)

Performs the |= operation.

impl Clone for PermissionMask

fn clone(&self) -> PermissionMask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PermissionMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PermissionMask

fn default() -> PermissionMask

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PermissionMask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PermissionMask

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PermissionMask