Go to the documentation of this file.
44 $logname = $reportOnly ?
'csp-report-only' :
'csp';
45 $this->log = LoggerFactory::getInstance( $logname );
46 $userAgent = $this->
getRequest()->getHeader(
'user-agent' );
55 'csp-report' => $report,
56 'method' => __METHOD__,
57 'user' => $this->
getUser()->getName(),
58 'user-agent' => $userAgent,
71 if ( in_array(
'false-positive',
$flags ) ) {
73 $this->log->debug( $logLine,
$context );
76 $this->log->warning( $logLine,
$context );
89 $falsePositives = $this->
getConfig()->get(
'CSPFalsePositiveUrls' );
100 ( isset( $report[
'blocked-uri'] ) &&
101 isset( $falsePositives[$report[
'blocked-uri']] ) )
102 || ( isset( $report[
'source-file'] ) &&
103 isset( $falsePositives[$report[
'source-file']] ) )
106 $flags[] =
'false-positive';
116 $contentType =
$req->getHeader(
'content-type' );
117 if ( $contentType !==
'application/json'
118 && $contentType !==
'application/csp-report'
120 $this->
error(
'wrongformat', __METHOD__ );
123 $this->
error(
'toobig', __METHOD__ );
133 $postBody = $this->
getRequest()->getRawInput();
134 if ( strlen( $postBody ) > self::MAX_POST_SIZE ) {
136 $this->
error(
'toobig', __METHOD__ );
140 $msg =
$status->getErrors()[0][
'message'];
141 if ( $msg instanceof Message ) {
142 $msg = $msg->getKey();
144 $this->
error( $msg, __METHOD__ );
149 if ( !isset( $report[
'csp-report'] ) ) {
150 $this->
error(
'missingkey', __METHOD__ );
152 return $report[
'csp-report'];
165 $flagText =
'[' . implode(
$flags,
', ' ) .
']';
168 $blockedFile = isset( $report[
'blocked-uri'] ) ? $report[
'blocked-uri'] :
'n/a';
169 $page = isset( $report[
'document-uri'] ) ? $report[
'document-uri'] :
'n/a';
170 $line = isset( $report[
'line-number'] ) ?
':' . $report[
'line-number'] :
'';
171 $warningText = $flagText .
172 ' Received CSP report: <' . $blockedFile .
173 '> blocked from being loaded on <' .
$page .
'>' .
$line;
185 $this->log->info(
'Error reading CSP report: ' .
$code, [
187 'user-agent' => $this->
getRequest()->getHeader(
'user-agent' )
getConfig()
Get the Config object.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
processing should stop and the error should be shown to the user * false
isWriteMode()
Indicates whether this module requires write mode.
const PARAM_REQUIRED
(boolean) Is the parameter required?
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
getResult()
Get the result object.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
this hook is for auditing only $req
mustBePosted()
Indicates whether this module must be called with a POST request.
getRequest()
Get the WebRequest object.
Api module to receive and log CSP violation reports.
getUser()
Get the User object.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
This abstract class implements many basic API functions, and is the base of all API classes.
shouldCheckMaxLag()
Doesn't touch db, so max lag should be rather irrelavent.
isInternal()
Mark as internal.
isReadMode()
Even if you don't have read rights, we still want your report.
getReport()
Get the report from post body and turn into associative array.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
logReport( $flags, $logLine, $context)
Log CSP report, with a different severity depending on $flags.
execute()
Logs a content-security-policy violation report from web browser.
getFlags( $report)
Get extra notes about the report.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
verifyPostBodyOk()
Output an api error if post body is obviously not OK.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
getModuleName()
Get the name of the module being executed by this instance.
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
error( $code, $method)
Stop processing the request, and output/log an error.
const MAX_POST_SIZE
These reports should be small.
generateLogLine( $flags, $report)
Get text of log line.
it s the revision text itself In either if gzip is the revision text is gzipped $flags