caps/nsIPrincipal.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /* Defines the abstract interface for a principal. */
   7
   8 #include "nsIContentSecurityPolicy.idl"
   9 #include "nsISerializable.idl"
  10 #include "nsIAboutModule.idl"
  11 #include "nsIReferrerInfo.idl"
  12 interface nsIChannel;
  13 #include "mozIDOMWindow.idl"
  14
  15 %{C++
  16 struct JSPrincipals;
  17 #include "nsCOMPtr.h"
  18 #include "nsTArray.h"
  19 #include "nsString.h"
  20 #include "mozilla/DebugOnly.h"
  21 namespace mozilla {
  22 class OriginAttributes;
  23 }
  24
  25 /**
  26  * Some methods have a fast path for the case when we're comparing a principal
  27  * to itself. The situation may happen for example with about:blank documents.
  28  */
  29
  30 #define DECL_FAST_INLINE_HELPER(method_)                       \
  31   inline bool method_(nsIPrincipal* aOther)                    \
  32   {                                                            \
  33     mozilla::DebugOnly<bool> val = false;                      \
  34     MOZ_ASSERT_IF(this == aOther,                              \
  35                   NS_SUCCEEDED(method_(aOther, &val)) && val); \
  36                                                                \
  37     bool retVal = false;                                       \
  38     return                                                     \
  39       this == aOther ||                                        \
  40       (NS_SUCCEEDED(method_(aOther, &retVal)) && retVal);      \
  41   }
  42
  43 %}
  44
  45 interface nsIURI;
  46
  47 webidl WebExtensionPolicy;
  48
  49 [ptr] native JSContext(JSContext);
  50 [ptr] native JSPrincipals(JSPrincipals);
  51 [ref] native PrincipalArray(const nsTArray<nsCOMPtr<nsIPrincipal>>);
  52 [ref] native const_OriginAttributes(const mozilla::OriginAttributes);
  53 native ReferrerPolicy(mozilla::dom::ReferrerPolicy);
  54
  55 [scriptable, builtinclass, uuid(f75f502d-79fd-48be-a079-e5a7b8f80c8b)]
  56 interface nsIPrincipal : nsISupports
  57 {
  58     /**
  59      * Returns whether the other principal is equivalent to this principal.
  60      * Principals are considered equal if they are the same principal, or
  61      * they have the same origin.
  62      *
  63      * May be called from any thread.
  64      */
  65     boolean equals(in nsIPrincipal other);
  66
  67     /**
  68      * Returns whether the other principal is equivalent to this principal
  69      * for permission purposes
  70      * Matches {originAttributes ,equalsURIForPermission}
  71      *
  72      * May be called from any thread.
  73      */
  74
  75     boolean equalsForPermission(in nsIPrincipal other, in bool aExactHost);
  76
  77     /**
  78      * Like equals, but takes document.domain changes into account.
  79      *
  80      * May be called from any thread, though document.domain may racily change
  81      * during the comparison when called from off-main-thread.
  82      */
  83     boolean equalsConsideringDomain(in nsIPrincipal other);
  84
  85     %{C++
  86       DECL_FAST_INLINE_HELPER(Equals)
  87       DECL_FAST_INLINE_HELPER(EqualsConsideringDomain)
  88     %}
  89
  90     /*
  91      * Returns whether the Principals URI is equal to the other URI
  92      *
  93      * May be called from any thread.
  94      */
  95     boolean equalsURI(in nsIURI aOtherURI);
  96
  97     /**
  98      * Returns a hash value for the principal.
  99      *
 100      * May be called from any thread.
 101      */
 102     [notxpcom, nostdcall] readonly attribute unsigned long hashValue;
 103
 104     /**
 105      * The principal URI to which this principal pertains.  This is
 106      * generally the document URI.
 107      *
 108      * May be called from any thread.
 109      */
 110     [infallible] readonly attribute nsIURI URI;
 111
 112     /**
 113      * The domain URI to which this principal pertains.
 114      * This is null unless script successfully sets document.domain to our URI
 115      * or a superdomain of our URI.
 116      * Setting this has no effect on the URI.
 117      * See https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#Changing_origin
 118      *
 119      * The getter may be called from any thread, but may only be set on the main thread.
 120      */
 121     [noscript] attribute nsIURI domain;
 122
 123     /**
 124      * Returns whether the other principal is equal to or weaker than this
 125      * principal. Principals are equal if they are the same object or they
 126      * have the same origin.
 127      *
 128      * Thus a principal always subsumes itself.
 129      *
 130      * The system principal subsumes itself and all other principals.
 131      *
 132      * A null principal (corresponding to an unknown, hence assumed minimally
 133      * privileged, security context) is not equal to any other principal
 134      * (including other null principals), and therefore does not subsume
 135      * anything but itself.
 136      *
 137      * May be called from any thread.
 138      */
 139     boolean subsumes(in nsIPrincipal other);
 140
 141     /**
 142      * Same as the previous method, subsumes(), but takes document.domain into
 143      * account.
 144      *
 145      * May be called from any thread, though document.domain may racily change
 146      * during the comparison when called from off-main-thread.
 147      */
 148     boolean subsumesConsideringDomain(in nsIPrincipal other);
 149
 150     /**
 151      * Same as the subsumesConsideringDomain(), but ignores the first party
 152      * domain in its originAttributes.
 153      *
 154      * May be called from any thread, though document.domain may racily change
 155      * during the comparison when called from off-main-thread.
 156      */
 157     boolean subsumesConsideringDomainIgnoringFPD(in nsIPrincipal other);
 158
 159     %{C++
 160       DECL_FAST_INLINE_HELPER(Subsumes)
 161       DECL_FAST_INLINE_HELPER(SubsumesConsideringDomain)
 162       DECL_FAST_INLINE_HELPER(SubsumesConsideringDomainIgnoringFPD)
 163 #undef DECL_FAST_INLINE_HELPER
 164     %}
 165
 166     /**
 167      * Checks whether this principal is allowed to load the network resource
 168      * located at the given URI under the same-origin policy. This means that
 169      * content principals are only allowed to load resources from the same
 170      * domain, the system principal is allowed to load anything, and null
 171      * principals can only load URIs where they are the principal. This is
 172      * changed by the optional flag allowIfInheritsPrincipal (which defaults to
 173      * false) which allows URIs that inherit their loader's principal.
 174      *
 175      * If the load is allowed this function does nothing. If the load is not
 176      * allowed the function throws NS_ERROR_DOM_BAD_URI.
 177      *
 178      * NOTE: Other policies might override this, such as the Access-Control
 179      *       specification.
 180      * NOTE: The 'domain' attribute has no effect on the behaviour of this
 181      *       function.
 182      * NOTE: Main-Thread Only.
 183      *
 184      *
 185      * @param uri    The URI about to be loaded.
 186      * @param allowIfInheritsPrincipal   If true, the load is allowed if the
 187      *                                   loadee inherits the principal of the
 188      *                                   loader.
 189      * @throws NS_ERROR_DOM_BAD_URI if the load is not allowed.
 190      */
 191     void checkMayLoad(in nsIURI uri,
 192                       in boolean allowIfInheritsPrincipal);
 193
 194     /**
 195      * Like checkMayLoad, but if returning an error will also report that error
 196      * to the console, using the provided window id.  The window id may be 0 to
 197      * report to just the browser console, not web consoles.
 198      *
 199      * NOTE: Main-Thread Only.
 200      */
 201     void checkMayLoadWithReporting(in nsIURI uri,
 202                                    in boolean allowIfInheritsPrincipal,
 203                                    in unsigned long long innerWindowID);
 204
 205     /**
 206      * Checks if the provided URI is considered third-party to the
 207      * URI of the principal.
 208      * Returns true if the URI is third-party.
 209      *
 210      * May be called from any thread.
 211      *
 212      * @param uri - The URI to check
 213      */
 214     boolean isThirdPartyURI(in nsIURI uri);
 215
 216     /**
 217      * Checks if the provided principal is considered third-party to the
 218      * URI of the Principal.
 219      * Returns true if the principal is third-party.
 220      *
 221      * May be called from any thread.
 222      *
 223      * @param principal - The principal to check
 224      */
 225     boolean isThirdPartyPrincipal(in nsIPrincipal principal);
 226
 227     /**
 228      * Checks if the provided channel is considered third-party to the
 229      * URI of the principal.
 230      * Returns true if the channel is third-party.
 231      * Returns false if the Principal is a System Principal
 232      *
 233      * NOTE: Main-Thread Only.
 234      *
 235      * @param channel - The Channel to check
 236      */
 237     boolean isThirdPartyChannel(in nsIChannel channel);
 238
 239     /**
 240      * A dictionary of the non-default origin attributes associated with this
 241      * nsIPrincipal.
 242      *
 243      * Attributes are tokens that are taken into account when determining whether
 244      * two principals are same-origin - if any attributes differ, the principals
 245      * are cross-origin, even if the scheme, host, and port are the same.
 246      * Attributes should also be considered for all security and bucketing decisions,
 247      * even those which make non-standard comparisons (like cookies, which ignore
 248      * scheme, or quotas, which ignore subdomains).
 249      *
 250      * If you're looking for an easy-to-use canonical stringification of the origin
 251      * attributes, see |originSuffix| below.
 252      */
 253     [implicit_jscontext]
 254     readonly attribute jsval originAttributes;
 255
 256     // May be called from any thread.
 257     [noscript, notxpcom, nostdcall, binaryname(OriginAttributesRef)]
 258     const_OriginAttributes OriginAttributesRef();
 259
 260     /**
 261      * A canonical representation of the origin for this principal. This
 262      * consists of a base string (which, for content principals, is of the
 263      * format scheme://host:port), concatenated with |originAttributes| (see
 264      * below).
 265      *
 266      * We maintain the invariant that principalA.equals(principalB) if and only
 267      * if principalA.origin == principalB.origin.
 268      *
 269      * May be called from any thread.
 270      */
 271     readonly attribute ACString origin;
 272
 273     /**
 274      * Returns an ASCII compatible serialization of the principal's origin, as
 275      * specified by the whatwg HTML specification. If the principal does not
 276      * have a host, the origin will be "null".
 277      *
 278      * https://html.spec.whatwg.org/multipage/browsers.html#ascii-serialisation-of-an-origin
 279      *
 280      * Note that this is different from `origin`, does not contain
 281      * gecko-specific metadata like origin attributes, and should not be used
 282      * for permissions or security checks.
 283      *
 284      * May be called from any thread.
 285      */
 286     [noscript] readonly attribute ACString webExposedOriginSerialization;
 287
 288     /**
 289      * Returns the "host:port" portion of the
 290      * Principals URI, if any.
 291      *
 292      * May be called from any thread.
 293      */
 294     readonly attribute ACString hostPort;
 295
 296     /**
 297      * Returns the "host:port" portion of the
 298      * Principals URI, if any.
 299      *
 300      * May be called from any thread.
 301      */
 302     readonly attribute ACString asciiHost;
 303
 304     /**
 305      * Returns the "host" portion of the
 306      * Principals URI, if any.
 307      *
 308      * May be called from any thread.
 309      */
 310     readonly attribute ACString host;
 311
 312     /**
 313      * Returns the prePath of the principals uri
 314      * follows the format scheme:
 315      * "scheme://username:password@hostname:portnumber/"
 316      *
 317      * May be called from any thread.
 318      */
 319     readonly attribute ACString prePath;
 320
 321     /**
 322      * Returns the filePath of the principals uri. See nsIURI.
 323      *
 324      * May be called from any thread.
 325      */
 326     readonly attribute ACString filePath;
 327
 328     /**
 329      * Returns the ASCII Spec from the Principals URI.
 330      * Might return the empty string, e.g. for the case of
 331      * a SystemPrincipal or an EpxandedPrincipal.
 332      *
 333      * May be called from any thread.
 334      *
 335      * WARNING: DO NOT USE FOR SECURITY CHECKS.
 336      * just for logging purposes!
 337      */
 338     readonly attribute ACString asciiSpec;
 339
 340     /**
 341      * Returns the Spec from the Principals URI.
 342      * Might return the empty string, e.g. for the case of
 343      * a SystemPrincipal or an EpxandedPrincipal.
 344      *
 345      * May be called from any thread.
 346      *
 347      * WARNING: Do not land new Code using, as this will be removed soon
 348      */
 349     readonly attribute ACString spec;
 350
 351     /**
 352      * Returns the Pre Path of the Principals URI with
 353      * user:pass stripped for privacy and spoof prevention
 354      *
 355      * May be called from any thread.
 356      */
 357     readonly attribute ACString exposablePrePath;
 358
 359     /**
 360      * Returns the Spec of the Principals URI with
 361      * user/pass/ref/query stripped for privacy and spoof prevention
 362      *
 363      * May be called from any thread.
 364      */
 365     readonly attribute ACString exposableSpec;
 366
 367     /**
 368      * Return the scheme of the principals URI
 369      *
 370      * May be called from any thread.
 371      */
 372     readonly attribute ACString scheme;
 373
 374     /**
 375      * Checks if the Principal's URI Scheme matches with the parameter
 376      *
 377      * May be called from any thread.
 378      *
 379      * @param scheme    The scheme to be checked
 380      */
 381     [infallible]
 382     boolean schemeIs(in string scheme);
 383
 384     /*
 385      * Checks if the Principal's URI is contained in the given Pref
 386      *
 387      * NOTE: Main-Thread Only.
 388      *
 389      * @param pref    The pref to be checked
 390      */
 391     [infallible]
 392     boolean isURIInPrefList(in string pref);
 393
 394     /**
 395      * Check if the Principal's URI is contained in the given list
 396      *
 397      * May be called from any thread.
 398      *
 399      * @param list The list to be checked
 400      */
 401     [infallible]
 402     boolean isURIInList(in ACString list);
 403
 404     /**
 405      * Check if the Principal's URI is a content-accessible about: page
 406      *
 407      * May be called from any thread.
 408      */
 409     [infallible]
 410     boolean isContentAccessibleAboutURI();
 411
 412     /**
 413      * Uses NS_Security Compare to determine if the
 414      * other URI is same-origin as the uri of the Principal
 415      *
 416      * May be called from any thread.
 417      */
 418     [infallible]
 419     boolean isSameOrigin(in nsIURI otherURI);
 420
 421     /*
 422      * Checks if the Principal is allowed to load the Provided file:// URI
 423      * using NS_RelaxStrictFileOriginPolicy
 424      *
 425      * May be called from any thread.
 426      */
 427     bool allowsRelaxStrictFileOriginPolicy(in nsIURI aURI);
 428
 429
 430     /*
 431      * Generates a Cache-Key for the Cors-Preflight Cache
 432      *
 433      * May be called from any thread.
 434      */
 435     [noscript]
 436     ACString getPrefLightCacheKey(in nsIURI aURI ,in bool aWithCredentials,
 437                                   in const_OriginAttributes aOriginAttributes);
 438
 439
 440     /*
 441      * Checks if the Principals URI has first party storage access
 442      * when loaded inside the provided 3rd party resource window.
 443      * See also: ContentBlocking::ShouldAllowAccessFor
 444      *
 445      * NOTE: Main-Thread Only.
 446      */
 447     bool hasFirstpartyStorageAccess(in mozIDOMWindow aWindow, out uint32_t rejectedReason);
 448
 449
 450     /*
 451      * Returns a Key for the LocalStorage Manager, used to
 452      * check the Principals Origin Storage usage.
 453      *
 454      * May be called from any thread.
 455      */
 456     readonly attribute ACString localStorageQuotaKey;
 457
 458     /**
 459      * Implementation of
 460      * https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy
 461      *
 462      * The value returned by this method feeds into the the Secure Context
 463      * algorithm that determins the value of Window.isSecureContext and
 464      * WorkerGlobalScope.isSecureContext.
 465      *
 466      * This method returns false instead of throwing upon errors.
 467      *
 468      * NOTE: Main-Thread Only.
 469      */
 470     [infallible]
 471     readonly attribute boolean isOriginPotentiallyTrustworthy;
 472
 473     /**
 474      * NOTE: Main-Thread Only.
 475      */
 476     [infallible]
 477     readonly attribute boolean isLoopbackHost;
 478
 479     /**
 480      * Returns the Flags of the Principals
 481      * associated AboutModule, in case there is one.
 482      *
 483      * NOTE: Main-Thread Only.
 484      */
 485     uint32_t getAboutModuleFlags();
 486
 487     /**
 488      * Returns the Key to access the Principals
 489      * Origin Local/Session Storage
 490      *
 491      * May be called from any thread.
 492      */
 493     readonly attribute ACString storageOriginKey;
 494
 495     /**
 496      * Creates and Returns a new ReferrerInfo with the
 497      * Principals URI
 498      *
 499      * May be called from any thread.
 500      */
 501     nsIReferrerInfo createReferrerInfo(in ReferrerPolicy aReferrerPolicy);
 502
 503     /**
 504      * The base part of |origin| without the concatenation with |originSuffix|.
 505      * This doesn't have the important invariants described above with |origin|,
 506      * and as such should only be used for legacy situations.
 507      *
 508      * May be called from any thread.
 509      */
 510     readonly attribute ACString originNoSuffix;
 511
 512     /**
 513      * A string of the form ^key1=value1&key2=value2, where each pair represents
 514      * an attribute with a non-default value. If all attributes have default
 515      * values, this is the empty string.
 516      *
 517      * The value of .originSuffix is automatically serialized into .origin, so any
 518      * consumers using that are automatically origin-attribute-aware. Consumers with
 519      * special requirements must inspect and compare .originSuffix manually.
 520      *
 521      * May be called from any thread.
 522      */
 523     readonly attribute AUTF8String originSuffix;
 524
 525     /**
 526      * A canonical representation of the site-origin for this principal.
 527      * This string has the same format as |origin| (see above). Two principals
 528      * with differing |siteOrigin| values will never compare equal, even when
 529      * considering domain mutations.
 530      *
 531      * For most principals, |siteOrigin| matches |origin| precisely. Only
 532      * principals which allow mutating |domain|, such as ContentPrincipal,
 533      * override the default implementation in BasePrincipal.
 534      *
 535      * May be called from any thread.
 536      */
 537     readonly attribute ACString siteOrigin;
 538
 539     /**
 540      * The base part of |siteOrigin| without the concatenation with
 541      * |originSuffix|.
 542      *
 543      * May be called from any thread.
 544      */
 545     readonly attribute ACString siteOriginNoSuffix;
 546
 547     /**
 548      * The base domain of the principal URI to which this principal pertains
 549      * (generally the document URI), handling null principals and
 550      * non-hierarchical schemes correctly.
 551      *
 552      * May be called from any thread.
 553      */
 554     readonly attribute ACString baseDomain;
 555
 556     /**
 557      * Gets the ID of the add-on this principal belongs to.
 558      *
 559      * May be called from any thread.
 560      */
 561     readonly attribute AString addonId;
 562
 563     /**
 564      * Gets the WebExtensionPolicy of the add-on this principal belongs to.
 565      *
 566      * NOTE: Main-Thread Only.
 567      */
 568     readonly attribute WebExtensionPolicy addonPolicy;
 569     readonly attribute WebExtensionPolicy contentScriptAddonPolicy;
 570
 571     /**
 572      * Gets the id of the user context this principal is inside.  If this
 573      * principal is inside the default userContext, this returns
 574      * nsIScriptSecurityManager::DEFAULT_USER_CONTEXT_ID.
 575      *
 576      * May be called from any thread.
 577      */
 578     [infallible] readonly attribute unsigned long userContextId;
 579
 580     /**
 581      * Gets the id of the private browsing state of the context containing
 582      * this principal. If the principal has a private browsing value of 0, it
 583      * is not in private browsing.
 584      *
 585      * May be called from any thread.
 586      */
 587     [infallible] readonly attribute unsigned long privateBrowsingId;
 588
 589     /**
 590      * Returns true iff the principal is inside an isolated mozbrowser element.
 591      * <xul:browser> is not considered to be a mozbrowser element.
 592      * <iframe mozbrowser noisolation> does not count as isolated since
 593      * isolation is disabled.  Isolation can only be disabled if the
 594      * containing document is chrome.
 595      *
 596      * May be called from any thread.
 597      */
 598     [infallible] readonly attribute boolean isInIsolatedMozBrowserElement;
 599
 600     /**
 601      * Returns true iff this is a null principal (corresponding to an
 602      * unknown, hence assumed minimally privileged, security context).
 603      *
 604      * May be called from any thread.
 605      */
 606     [infallible] readonly attribute boolean isNullPrincipal;
 607
 608     /**
 609      * Returns true iff this principal corresponds to a principal origin.
 610      *
 611      * May be called from any thread.
 612      */
 613     [infallible] readonly attribute boolean isContentPrincipal;
 614
 615     /**
 616      * Returns true iff this is an expanded principal.
 617      *
 618      * May be called from any thread.
 619      */
 620     [infallible] readonly attribute boolean isExpandedPrincipal;
 621
 622     /**
 623      * Returns true iff this is the system principal.  C++ callers should use
 624      * IsSystemPrincipal() instead of this scriptable accessor.
 625      *
 626      * May be called from any thread.
 627      */
 628     readonly attribute boolean isSystemPrincipal;
 629
 630     /**
 631      * Faster and nicer version callable from C++.  Callers must include
 632      * BasePrincipal.h, where it's implemented.
 633      *
 634      * May be called from any thread.
 635      */
 636     %{C++
 637       inline bool IsSystemPrincipal() const;
 638     %}
 639
 640     /**
 641      * Returns true iff the principal is either an addon principal or
 642      * an expanded principal, which contains at least one addon principal.
 643      *
 644      * May be called from any thread.
 645      */
 646     [infallible] readonly attribute boolean isAddonOrExpandedAddonPrincipal;
 647
 648     %{C++
 649     // MOZ_DBG support (threadsafe)
 650     friend std::ostream& operator<<(std::ostream& aOut, const nsIPrincipal& aPrincipal) {
 651       nsIPrincipal* principal = const_cast<nsIPrincipal*>(&aPrincipal);
 652       nsAutoCString origin;
 653       mozilla::DebugOnly<nsresult> rv = principal->GetOrigin(origin);
 654       MOZ_ASSERT(NS_SUCCEEDED(rv));
 655       return aOut << "nsIPrincipal { " << origin << " }";
 656     }
 657     %}
 658
 659     /**
 660      * Returns true if the URI is an Onion URI.
 661      *
 662      * May be called from any thread.
 663      */
 664     [infallible] readonly attribute boolean isOnion;
 665
 666     /**
 667      * Returns true if the Domain Policy allows js execution
 668      * for the Principal's URI
 669      *
 670      * NOTE: Main-Thread Only.
 671      */
 672     readonly attribute boolean isScriptAllowedByPolicy;
 673
 674
 675     /**
 676      * Returns true if the Principal can acess l10n
 677      * features for the Provided DocumentURI
 678      *
 679      * NOTE: Main-Thread Only.
 680      */
 681     boolean isL10nAllowed(in nsIURI aDocumentURI);
 682
 683     /**
 684      * Returns a nsIPrincipal, with one less Subdomain Segment
 685      * Returns `nullptr` if there are no more segments to remove.
 686      *
 687      * May be called from any thread.
 688      */
 689     [infallible] readonly attribute nsIPrincipal nextSubDomainPrincipal;
 690
 691     /**
 692      * Returns if the principal is for an IP address.
 693      *
 694      * May be called from any thread.
 695      */
 696     [infallible] readonly attribute boolean isIpAddress;
 697
 698     /**
 699      * Returns if the principal is for a local IP address.
 700      *
 701      * May be called from any thread.
 702      */
 703     [infallible] readonly attribute boolean isLocalIpAddress;
 704
 705     /**
 706      * If this principal is a null principal, reconstruct the precursor
 707      * principal which this null principal was derived from. This may be null,
 708      * in which case this is not a null principal, there is no known precursor
 709      * to this null principal, it was created by a privileged context, or there
 710      * was a bugged origin in the precursor string.
 711      *
 712      * May be called from any thread.
 713      *
 714      * WARNING: Be careful when using this principal, as it is not part of the
 715      * security properties of the null principal, and should NOT be used to
 716      * grant a resource with a null principal access to resources from its
 717      * precursor origin. This is only to be used for places where tracking how
 718      * null principals were created is necessary.
 719      */
 720     [infallible] readonly attribute nsIPrincipal precursorPrincipal;
 721 };
 722
 723 /**
 724  * If SystemPrincipal is too risky to use, but we want a principal to access
 725  * more than one origin, ExpandedPrincipals letting us define an array of
 726  * principals it subsumes. So script with an ExpandedPrincipals will gain
 727  * same origin access when at least one of its principals it contains gained
 728  * sameorigin acccess. An ExpandedPrincipal will be subsumed by the system
 729  * principal, and by another ExpandedPrincipal that has all its principals.
 730  * It is added for jetpack content-scripts to let them interact with the
 731  * content and a well defined set of other domains, without the risk of
 732  * leaking out a system principal to the content. See: Bug 734891
 733  */
 734 [uuid(f3e177Df-6a5e-489f-80a7-2dd1481471d8)]
 735 interface nsIExpandedPrincipal : nsISupports
 736 {
 737   /**
 738    * An array of principals that the expanded principal subsumes.
 739    *
 740    * When an expanded principal is used as a triggering principal for a
 741    * request that inherits a security context, one of its constitutent
 742    * principals is inherited rather than the expanded principal itself. The
 743    * last principal in the allowlist is the default principal to inherit.
 744    *
 745    * Note: this list is not reference counted, it is shared, so
 746    * should not be changed and should only be used ephemerally.
 747    *
 748    * May be called from any thread.
 749    */
 750   [noscript, notxpcom, nostdcall]
 751   PrincipalArray AllowList();
 752
 753
 754   /**
 755    * Bug 1548468: Move CSP off ExpandedPrincipal.
 756    *
 757    * A Content Security Policy associated with this principal. Use this function
 758    * to query the associated CSP with this principal.
 759    *
 760    * NOTE: Main-Thread Only.
 761    */
 762   readonly attribute nsIContentSecurityPolicy csp;
 763
 764 %{ C++
 765   inline already_AddRefed<nsIContentSecurityPolicy> GetCsp()
 766   {
 767     nsCOMPtr<nsIContentSecurityPolicy> result;
 768     mozilla::DebugOnly<nsresult> rv = GetCsp(getter_AddRefs(result));
 769     MOZ_ASSERT(NS_SUCCEEDED(rv));
 770     return result.forget();
 771   }
 772 %}
 773
 774 };