netwerk/cookie/nsICookie.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 /**
  10  * Main cookie object interface.
  11  */
  12
  13 typedef long nsCookieStatus;
  14 typedef long nsCookiePolicy;
  15
  16 [builtinclass, scriptable, uuid(adf0db5e-211e-45a3-be14-4486ac430a58)]
  17 interface nsICookie : nsISupports {
  18     const uint32_t SAMESITE_NONE   = 0;
  19     const uint32_t SAMESITE_LAX    = 1;
  20     const uint32_t SAMESITE_STRICT = 2;
  21
  22     /**
  23      * the name of the cookie
  24      */
  25     readonly attribute ACString name;
  26
  27     /**
  28      * the cookie value
  29      */
  30     readonly attribute AUTF8String value;
  31
  32     /**
  33      * true if the cookie is a domain cookie, false otherwise
  34      */
  35     readonly attribute boolean isDomain;
  36
  37     /**
  38      * the host (possibly fully qualified) of the cookie
  39      */
  40     readonly attribute AUTF8String host;
  41
  42     /**
  43      * the host (possibly fully qualified) of the cookie,
  44      * without a leading dot to represent if it is a
  45      * domain cookie.
  46      */
  47     readonly attribute AUTF8String rawHost;
  48
  49     /**
  50      * the path pertaining to the cookie
  51      */
  52     readonly attribute AUTF8String path;
  53
  54     /**
  55      * true if the cookie was transmitted over ssl, false otherwise
  56      */
  57     readonly attribute boolean isSecure;
  58
  59     /**
  60      * @DEPRECATED use nsICookie.expiry and nsICookie.isSession instead.
  61      *
  62      * expiration time in seconds since midnight (00:00:00), January 1, 1970 UTC.
  63      * expires = 0 represents a session cookie.
  64      * expires = 1 represents an expiration time earlier than Jan 1, 1970.
  65      */
  66     readonly attribute uint64_t expires;
  67
  68     /**
  69      * the actual expiry time of the cookie, in seconds
  70      * since midnight (00:00:00), January 1, 1970 UTC.
  71      *
  72      * this is distinct from nsICookie::expires, which
  73      * has different and obsolete semantics.
  74      */
  75     readonly attribute int64_t expiry;
  76
  77     /**
  78      * The origin attributes for this cookie
  79      */
  80     [implicit_jscontext]
  81     readonly attribute jsval originAttributes;
  82
  83     /**
  84      * true if the cookie is a session cookie.
  85      * note that expiry time will also be honored
  86      * for session cookies (see below); thus, whichever is
  87      * the more restrictive of the two will take effect.
  88      */
  89     readonly attribute boolean isSession;
  90
  91     /**
  92      * true if the cookie is an http only cookie
  93      */
  94     readonly attribute boolean isHttpOnly;
  95
  96     /**
  97      * the creation time of the cookie, in microseconds
  98      * since midnight (00:00:00), January 1, 1970 UTC.
  99      */
 100     readonly attribute int64_t creationTime;
 101
 102     /**
 103      * the last time the cookie was accessed (i.e. created,
 104      * modified, or read by the server), in microseconds
 105      * since midnight (00:00:00), January 1, 1970 UTC.
 106      *
 107      * note that this time may be approximate.
 108      */
 109     readonly attribute int64_t lastAccessed;
 110
 111     /**
 112      * the SameSite attribute; this controls the cookie behavior for cross-site
 113      * requests as per
 114      * https://tools.ietf.org/html/draft-west-first-party-cookies-07
 115      *
 116      * This should be one of:
 117      * - SAMESITE_NONE - the SameSite attribute is not present
 118      * - SAMESITE_LAX - the SameSite attribute is present, but not strict
 119      * - SAMESITE_STRICT - the SameSite attribute is present and strict
 120      */
 121     readonly attribute int32_t sameSite;
 122
 123     /**
 124      * The list of possible schemes of cookies. It's a bitmap because a cookie
 125      * can be set on HTTP and HTTPS. At the moment, we treat it as the same
 126      * cookie.
 127      */
 128     cenum schemeType : 8 {
 129       SCHEME_UNSET = 0x00,
 130       SCHEME_HTTP = 0x01,
 131       SCHEME_HTTPS = 0x02,
 132       SCHEME_FILE = 0x04,
 133     };
 134
 135     /**
 136      * Bitmap of schemes.
 137      */
 138     readonly attribute nsICookie_schemeType schemeMap;
 139 };