зеркало из https://github.com/mozilla/gecko-dev.git
425 строки
18 KiB
Plaintext
425 строки
18 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
/**
|
|
* This file contains an interface to the Permission Manager,
|
|
* used to persistenly store permissions for different object types (cookies,
|
|
* images etc) on a site-by-site basis.
|
|
*
|
|
* This service broadcasts the following notification when the permission list
|
|
* is changed:
|
|
*
|
|
* topic : "perm-changed" (PERM_CHANGE_NOTIFICATION)
|
|
* broadcast whenever the permission list changes in some way. there
|
|
* are four possible data strings for this notification; one
|
|
* notification will be broadcast for each change, and will involve
|
|
* a single permission.
|
|
* subject: an nsIPermission interface pointer representing the permission object
|
|
* that changed.
|
|
* data : "deleted"
|
|
* a permission was deleted. the subject is the deleted permission.
|
|
* "added"
|
|
* a permission was added. the subject is the added permission.
|
|
* "changed"
|
|
* a permission was changed. the subject is the new permission.
|
|
* "cleared"
|
|
* the entire permission list was cleared. the subject is null.
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIURI;
|
|
interface nsIObserver;
|
|
interface nsIPrincipal;
|
|
interface mozIDOMWindow;
|
|
interface nsIPermission;
|
|
interface nsISimpleEnumerator;
|
|
interface nsIRunnable;
|
|
|
|
%{ C++
|
|
namespace IPC {
|
|
struct Permission;
|
|
}
|
|
#include "nsTArrayForwardDeclare.h"
|
|
%}
|
|
[ref] native IPCPermissionArrayRef(nsTArray<IPC::Permission>);
|
|
|
|
[scriptable, builtinclass, uuid(4dcb3851-eba2-4e42-b236-82d2596fca22)]
|
|
interface nsIPermissionManager : nsISupports
|
|
{
|
|
/**
|
|
* Predefined return values for the testPermission method and for
|
|
* the permission param of the add method
|
|
* NOTE: UNKNOWN_ACTION (0) is reserved to represent the
|
|
* default permission when no entry is found for a host, and
|
|
* should not be used by consumers to indicate otherwise.
|
|
*/
|
|
const uint32_t UNKNOWN_ACTION = 0;
|
|
const uint32_t ALLOW_ACTION = 1;
|
|
const uint32_t DENY_ACTION = 2;
|
|
const uint32_t PROMPT_ACTION = 3;
|
|
|
|
/**
|
|
* Predefined expiration types for permissions. Permissions can be permanent
|
|
* (never expire), expire at the end of the session, or expire at a specified
|
|
* time. Permissions that expire at the end of a session may also have a
|
|
* specified expiration time.
|
|
*
|
|
* EXPIRE_POLICY is a special expiration status. It is set when the permission
|
|
* is set by reading an enterprise policy. These permissions cannot be overridden.
|
|
*/
|
|
const uint32_t EXPIRE_NEVER = 0;
|
|
const uint32_t EXPIRE_SESSION = 1;
|
|
const uint32_t EXPIRE_TIME = 2;
|
|
const uint32_t EXPIRE_POLICY = 3;
|
|
|
|
/**
|
|
* Add permission information for a given URI and permission type. This
|
|
* operation will cause the type string to be registered if it does not
|
|
* currently exist. If a permission already exists for a given type, it
|
|
* will be modified.
|
|
*
|
|
* @param uri the uri to add the permission for
|
|
* @param type a case-sensitive ASCII string, identifying the consumer.
|
|
* Consumers should choose this string to be unique, with
|
|
* respect to other consumers.
|
|
* @param permission an integer representing the desired action (e.g. allow
|
|
* or deny). The interpretation of this number is up to the
|
|
* consumer, and may represent different actions for different
|
|
* types. Consumers may use one of the enumerated permission
|
|
* actions defined above, for convenience.
|
|
* NOTE: UNKNOWN_ACTION (0) is reserved to represent the
|
|
* default permission when no entry is found for a host, and
|
|
* should not be used by consumers to indicate otherwise.
|
|
* @param expiretype a constant defining whether this permission should
|
|
* never expire (EXPIRE_NEVER), expire at the end of the
|
|
* session (EXPIRE_SESSION), or expire at a specified time
|
|
* (EXPIRE_TIME).
|
|
* @param expiretime an integer representation of when this permission
|
|
* should be forgotten (milliseconds since Jan 1 1970 0:00:00).
|
|
*/
|
|
void add(in nsIURI uri,
|
|
in ACString type,
|
|
in uint32_t permission,
|
|
[optional] in uint32_t expireType,
|
|
[optional] in int64_t expireTime);
|
|
|
|
/**
|
|
* Deprecated! Use getAllForPrincipal!
|
|
* Get all custom permissions for a given URI. This will return
|
|
* an enumerator of all permissions which are not set to default
|
|
* and which belong to the matching principal of the given URI.
|
|
*
|
|
* @param uri the URI to get all permissions for
|
|
*/
|
|
nsISimpleEnumerator getAllForURI(in nsIURI uri);
|
|
|
|
/**
|
|
* Get all custom permissions for a given nsIPrincipal. This will return an
|
|
* enumerator of all permissions which are not set to default and which
|
|
* belong to the matching principal of the given nsIPrincipal.
|
|
*
|
|
* @param principal the URI to get all permissions for
|
|
*/
|
|
nsISimpleEnumerator getAllForPrincipal(in nsIPrincipal principal);
|
|
|
|
/**
|
|
* Get all custom permissions of a specific type, specified with a prefix
|
|
* string. This will return an array of all permissions which are not set to
|
|
* default. Also the passed type argument is either equal to or a prefix of
|
|
* the type of the returned permissions.
|
|
*
|
|
* @param prefix the type prefix string
|
|
*/
|
|
Array<nsIPermission> getAllWithTypePrefix(in ACString prefix);
|
|
|
|
/**
|
|
* Add permission information for a given principal.
|
|
* It is internally calling the other add() method using the nsIURI from the
|
|
* principal.
|
|
* Passing a system principal will be a no-op because they will always be
|
|
* granted permissions.
|
|
*/
|
|
void addFromPrincipal(in nsIPrincipal principal, in ACString type,
|
|
in uint32_t permission,
|
|
[optional] in uint32_t expireType,
|
|
[optional] in int64_t expireTime);
|
|
|
|
/**
|
|
* Remove permission information for a given URI and permission type. This will
|
|
* remove the permission for the entire host described by the uri, acting as the
|
|
* opposite operation to the add() method.
|
|
*
|
|
* @param uri the uri to remove the permission for
|
|
* @param type a case-sensitive ASCII string, identifying the consumer.
|
|
* The type must have been previously registered using the
|
|
* add() method.
|
|
*/
|
|
void remove(in nsIURI uri,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Remove permission information for a given principal.
|
|
* This is internally calling remove() with the host from the principal's URI.
|
|
* Passing system principal will be a no-op because we never add them to the
|
|
* database.
|
|
*/
|
|
void removeFromPrincipal(in nsIPrincipal principal, in ACString type);
|
|
|
|
/**
|
|
* Remove the given permission from the permission manager.
|
|
*
|
|
* @param perm a permission obtained from the permission manager.
|
|
*/
|
|
void removePermission(in nsIPermission perm);
|
|
|
|
/**
|
|
* Clear permission information for all websites.
|
|
*/
|
|
void removeAll();
|
|
|
|
/**
|
|
* Clear all permission information added since the specified time.
|
|
*/
|
|
void removeAllSince(in int64_t since);
|
|
|
|
/**
|
|
* Clear all permissions of the passed type.
|
|
*/
|
|
void removeByType(in ACString type);
|
|
|
|
/**
|
|
* Clear all permissions of the passed type added since the specified time.
|
|
* @param type a case-sensitive ASCII string, identifying the permission.
|
|
* @param since a unix timestamp representing the number of milliseconds from
|
|
* Jan 1, 1970 00:00:00 UTC.
|
|
*/
|
|
void removeByTypeSince(in ACString type, in int64_t since);
|
|
|
|
/**
|
|
* Test whether a website has permission to perform the given action.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
* @param uri the uri to be tested
|
|
* @param type a case-sensitive ASCII string, identifying the consumer
|
|
* @param return see add(), param permission. returns UNKNOWN_ACTION when
|
|
* there is no stored permission for this uri and / or type.
|
|
*/
|
|
uint32_t testPermission(in nsIURI uri,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Test whether the principal has the permission to perform a given action.
|
|
* System principals will always have permissions granted.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
*/
|
|
uint32_t testPermissionFromPrincipal(in nsIPrincipal principal,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Test whether a website specified by a given origin string has permission
|
|
* to perform the given action. This function is similar to testPermission()
|
|
* and is intended to be used where the cost of parsing a URI in the common
|
|
* case is to be avoided.
|
|
* @param originNoSuffix the origin string to be tested.
|
|
* @param type a case-sensitive ASCII string, identifying the
|
|
* permission.
|
|
* @param return see add(), param permission. returns UNKNOWN_ACTION
|
|
* when there is no stored permission for this uri and/
|
|
* or type.
|
|
*/
|
|
uint32_t testPermissionOriginNoSuffix(in ACString originNoSuffix,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Test whether the principal associated with the window's document has the
|
|
* permission to perform a given action. System principals will always
|
|
* have permissions granted.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
*/
|
|
uint32_t testPermissionFromWindow(in mozIDOMWindow window,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Test whether a website has permission to perform the given action.
|
|
* This requires an exact hostname match, subdomains are not a match.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
* @param uri the uri to be tested
|
|
* @param type a case-sensitive ASCII string, identifying the consumer
|
|
* @param return see add(), param permission. returns UNKNOWN_ACTION when
|
|
* there is no stored permission for this uri and / or type.
|
|
*/
|
|
uint32_t testExactPermission(in nsIURI uri,
|
|
in ACString type);
|
|
|
|
/**
|
|
* See testExactPermission() above.
|
|
* System principals will always have permissions granted.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
*/
|
|
uint32_t testExactPermissionFromPrincipal(in nsIPrincipal principal,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Test whether a website has permission to perform the given action
|
|
* ignoring active sessions.
|
|
* System principals will always have permissions granted.
|
|
* This function will perform a pref lookup to permissions.default.<type>
|
|
* if the specific permission type is part of the whitelist for that functionality.
|
|
*
|
|
* @param principal the principal
|
|
* @param type a case-sensitive ASCII string, identifying the consumer
|
|
* @param return see add(), param permission. returns UNKNOWN_ACTION when
|
|
* there is no stored permission for this uri and / or type.
|
|
*/
|
|
uint32_t testExactPermanentPermission(in nsIPrincipal principal,
|
|
in ACString type);
|
|
|
|
/**
|
|
* Get the permission object associated with the given URI and action.
|
|
* @param uri The URI
|
|
* @param type A case-sensitive ASCII string identifying the consumer
|
|
* @param exactHost If true, only the specific host will be matched,
|
|
* @see testExactPermission. If false, subdomains will
|
|
* also be searched, @see testPermission.
|
|
* @returns The matching permission object, or null if no matching object
|
|
* was found. No matching object is equivalent to UNKNOWN_ACTION.
|
|
* @note Clients in general should prefer the test* methods unless they
|
|
* need to know the specific stored details.
|
|
* @note This method will always return null for the system principal.
|
|
*/
|
|
nsIPermission getPermissionObjectForURI(in nsIURI uri,
|
|
in ACString type,
|
|
in boolean exactHost);
|
|
|
|
/**
|
|
* Get the permission object associated with the given principal and action.
|
|
* @param principal The principal
|
|
* @param type A case-sensitive ASCII string identifying the consumer
|
|
* @param exactHost If true, only the specific host will be matched,
|
|
* @see testExactPermission. If false, subdomains will
|
|
* also be searched, @see testPermission.
|
|
* @returns The matching permission object, or null if no matching object
|
|
* was found. No matching object is equivalent to UNKNOWN_ACTION.
|
|
* @note Clients in general should prefer the test* methods unless they
|
|
* need to know the specific stored details.
|
|
* @note This method will always return null for the system principal.
|
|
*/
|
|
nsIPermission getPermissionObject(in nsIPrincipal principal,
|
|
in ACString type,
|
|
in boolean exactHost);
|
|
|
|
/**
|
|
* Allows enumeration of all stored permissions
|
|
* @return an nsISimpleEnumerator interface that allows access to
|
|
* nsIPermission objects
|
|
*/
|
|
readonly attribute nsISimpleEnumerator enumerator;
|
|
|
|
/**
|
|
* Remove all permissions that will match the origin pattern.
|
|
*/
|
|
void removePermissionsWithAttributes(in AString patternAsJSON);
|
|
|
|
/**
|
|
* If the current permission is set to expire, reset the expiration time. If
|
|
* there is no permission or the current permission does not expire, this
|
|
* method will silently return.
|
|
*
|
|
* @param sessionExpiretime an integer representation of when this permission
|
|
* should be forgotten (milliseconds since
|
|
* Jan 1 1970 0:00:00), if it is currently
|
|
* EXPIRE_SESSION.
|
|
* @param sessionExpiretime an integer representation of when this permission
|
|
* should be forgotten (milliseconds since
|
|
* Jan 1 1970 0:00:00), if it is currently
|
|
* EXPIRE_TIME.
|
|
*/
|
|
void updateExpireTime(in nsIPrincipal principal,
|
|
in ACString type,
|
|
in boolean exactHost,
|
|
in uint64_t sessionExpireTime,
|
|
in uint64_t persistentExpireTime);
|
|
|
|
/**
|
|
* The content process doesn't have access to every permission. Instead, when
|
|
* LOAD_DOCUMENT_URI channels for http://, https://, and ftp:// URIs are
|
|
* opened, the permissions for those channels are sent down to the content
|
|
* process before the OnStartRequest message. Permissions for principals with
|
|
* other schemes are sent down at process startup.
|
|
*
|
|
* Permissions are keyed and grouped by "Permission Key"s.
|
|
* `nsPermissionManager::GetKeyForPrincipal` provides the mechanism for
|
|
* determining the permission key for a given principal.
|
|
*
|
|
* This method may only be called in the parent process. It fills the nsTArray
|
|
* argument with the IPC::Permission objects which have a matching permission
|
|
* key.
|
|
*
|
|
* @param permissionKey The key to use to find the permissions of interest.
|
|
* @param perms An array which will be filled with the permissions which
|
|
* match the given permission key.
|
|
*/
|
|
void getPermissionsWithKey(in ACString permissionKey, out IPCPermissionArrayRef perms);
|
|
|
|
/**
|
|
* See `nsIPermissionManager::GetPermissionsWithKey` for more info on
|
|
* Permission keys.
|
|
*
|
|
* `SetPermissionsWithKey` may only be called in the Child process, and
|
|
* initializes the permission manager with the permissions for a given
|
|
* Permission key. marking permissions with that key as available.
|
|
*
|
|
* @param permissionKey The key for the permissions which have been sent over.
|
|
* @param perms An array with the permissions which match the given key.
|
|
*/
|
|
void setPermissionsWithKey(in ACString permissionKey, in IPCPermissionArrayRef perms);
|
|
|
|
/**
|
|
* Broadcasts permissions for the given principal to all content processes.
|
|
*
|
|
* DO NOT USE THIS METHOD if you can avoid it. It was added in bug XXX to
|
|
* handle the current temporary implementation of ServiceWorker debugging. It
|
|
* will be removed when service worker debugging is fixed.
|
|
*
|
|
* @param aPrincipal The principal to broadcast permissions for.
|
|
*/
|
|
void broadcastPermissionsForPrincipalToAllContentProcesses(in nsIPrincipal aPrincipal);
|
|
|
|
/**
|
|
* Add a callback which should be run when all permissions are available for
|
|
* the given nsIPrincipal. This method invokes the callback runnable
|
|
* synchronously when the permissions are already available. Otherwise the
|
|
* callback will be run asynchronously in SystemGroup when all permissions
|
|
* are available in the future.
|
|
*
|
|
* NOTE: This method will not request the permissions be sent by the parent
|
|
* process. This should only be used to wait for permissions which may not
|
|
* have arrived yet in order to ensure they are present.
|
|
*
|
|
* @param aPrincipal The principal to wait for permissions to be available for.
|
|
* @param aRunnable The runnable to run when permissions are available for the
|
|
* given principal.
|
|
*/
|
|
void whenPermissionsAvailable(in nsIPrincipal aPrincipal,
|
|
in nsIRunnable aRunnable);
|
|
|
|
/**
|
|
* True if any "preload" permissions are present. This is used to avoid making
|
|
* potentially expensive permissions checks in nsContentBlocker.
|
|
*/
|
|
[infallible] readonly attribute boolean hasPreloadPermissions;
|
|
};
|
|
|
|
%{ C++
|
|
#define NS_PERMISSIONMANAGER_CONTRACTID "@mozilla.org/permissionmanager;1"
|
|
|
|
#define PERM_CHANGE_NOTIFICATION "perm-changed"
|
|
%}
|