mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-20 16:55:40 +00:00
a20be9ee64
Differential Revision: https://phabricator.services.mozilla.com/D45848 --HG-- extra : moz-landing-system : lando
75 lines
2.6 KiB
Plaintext
75 lines
2.6 KiB
Plaintext
/* 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/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsICookie;
|
|
interface nsIURI;
|
|
interface nsIChannel;
|
|
interface nsIPrincipal;
|
|
|
|
typedef long nsCookieAccess;
|
|
|
|
/**
|
|
* An interface to test for cookie permissions
|
|
*/
|
|
[scriptable, uuid(11ddd4ed-8f5b-40b3-b2a0-27c20ea1c88d)]
|
|
interface nsICookiePermission : nsISupports
|
|
{
|
|
/**
|
|
* nsCookieAccess values
|
|
*/
|
|
const nsCookieAccess ACCESS_DEFAULT = 0;
|
|
const nsCookieAccess ACCESS_ALLOW = 1;
|
|
const nsCookieAccess ACCESS_DENY = 2;
|
|
|
|
/**
|
|
* additional values for nsCookieAccess which may not match
|
|
* nsIPermissionManager. Keep 3-7 available to allow nsIPermissionManager to
|
|
* add values without colliding. ACCESS_SESSION is not directly returned by
|
|
* any methods on this interface.
|
|
*/
|
|
const nsCookieAccess ACCESS_SESSION = 8;
|
|
|
|
/**
|
|
* Don't use values 9 and 10! They used to be ACCESS_ALLOW_FIRST_PARTY_ONLY
|
|
* and ACCESS_LIMIT_THIRD_PARTY, now removed, but maybe still stored in some
|
|
* ancient user profiles.
|
|
*/
|
|
|
|
/**
|
|
* canSetCookie
|
|
*
|
|
* this method is called to test whether or not the given URI/channel may
|
|
* set a specific cookie. this method is always preceded by a call to
|
|
* canAccess. it may modify the isSession and expiry attributes of the
|
|
* cookie via the aIsSession and aExpiry parameters, in order to limit
|
|
* or extend the lifetime of the cookie. this is useful, for instance, to
|
|
* downgrade a cookie to session-only if it fails to meet certain criteria.
|
|
*
|
|
* @param aURI
|
|
* the URI trying to set the cookie
|
|
* @param aChannel
|
|
* the channel corresponding to aURI
|
|
* @param aCookie
|
|
* the cookie being added to the cookie database
|
|
* @param aIsSession
|
|
* when canSetCookie is invoked, this is the current isSession attribute
|
|
* of the cookie. canSetCookie may leave this value unchanged to
|
|
* preserve this attribute of the cookie.
|
|
* @param aExpiry
|
|
* when canSetCookie is invoked, this is the current expiry time of
|
|
* the cookie. canSetCookie may leave this value unchanged to
|
|
* preserve this attribute of the cookie.
|
|
*
|
|
* @return true if the cookie can be set.
|
|
*/
|
|
boolean canSetCookie(in nsIURI aURI,
|
|
in nsIChannel aChannel,
|
|
in nsICookie aCookie,
|
|
inout boolean aIsSession,
|
|
inout int64_t aExpiry);
|
|
};
|
|
|