MediaWiki  1.28.0
ApiCSPReport.php
Go to the documentation of this file.
1 <?php
24 
30 class ApiCSPReport extends ApiBase {
31 
32  private $log;
33 
37  const MAX_POST_SIZE = 8192;
38 
42  public function execute() {
43  $reportOnly = $this->getParameter( 'reportonly' );
44  $logname = $reportOnly ? 'csp-report-only' : 'csp';
45  $this->log = LoggerFactory::getInstance( $logname );
46  $userAgent = $this->getRequest()->getHeader( 'user-agent' );
47 
48  $this->verifyPostBodyOk();
49  $report = $this->getReport();
50  $flags = $this->getFlags( $report );
51 
52  $warningText = $this->generateLogLine( $flags, $report );
53  $this->logReport( $flags, $warningText, [
54  // XXX Is it ok to put untrusted data into log??
55  'csp-report' => $report,
56  'method' => __METHOD__,
57  'user' => $this->getUser()->getName(),
58  'user-agent' => $userAgent,
59  'source' => $this->getParameter( 'source' ),
60  ] );
61  $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
62  }
63 
70  private function logReport( $flags, $logLine, $context ) {
71  if ( in_array( 'false-positive', $flags ) ) {
72  // These reports probably don't matter much
73  $this->log->debug( $logLine, $context );
74  } else {
75  // Normal report.
76  $this->log->warning( $logLine, $context );
77  }
78  }
79 
86  private function getFlags( $report ) {
87  $reportOnly = $this->getParameter( 'reportonly' );
88  $source = $this->getParameter( 'source' );
89  $falsePositives = $this->getConfig()->get( 'CSPFalsePositiveUrls' );
90 
91  $flags = [];
92  if ( $source !== 'internal' ) {
93  $flags[] = 'source=' . $source;
94  }
95  if ( $reportOnly ) {
96  $flags[] = 'report-only';
97  }
98 
99  if (
100  ( isset( $report['blocked-uri'] ) &&
101  isset( $falsePositives[$report['blocked-uri']] ) )
102  || ( isset( $report['source-file'] ) &&
103  isset( $falsePositives[$report['source-file']] ) )
104  ) {
105  // Report caused by Ad-Ware
106  $flags[] = 'false-positive';
107  }
108  return $flags;
109  }
110 
114  private function verifyPostBodyOk() {
115  $req = $this->getRequest();
116  $contentType = $req->getHeader( 'content-type' );
117  if ( $contentType !== 'application/json'
118  && $contentType !=='application/csp-report'
119  ) {
120  $this->error( 'wrongformat', __METHOD__ );
121  }
122  if ( $req->getHeader( 'content-length' ) > self::MAX_POST_SIZE ) {
123  $this->error( 'toobig', __METHOD__ );
124  }
125  }
126 
132  private function getReport() {
133  $postBody = $this->getRequest()->getRawInput();
134  if ( strlen( $postBody ) > self::MAX_POST_SIZE ) {
135  // paranoia, already checked content-length earlier.
136  $this->error( 'toobig', __METHOD__ );
137  }
139  if ( !$status->isGood() ) {
140  list( $code, ) = $this->getErrorFromStatus( $status );
141  $this->error( $code, __METHOD__ );
142  }
143 
144  $report = $status->getValue();
145 
146  if ( !isset( $report['csp-report'] ) ) {
147  $this->error( 'missingkey', __METHOD__ );
148  }
149  return $report['csp-report'];
150  }
151 
159  private function generateLogLine( $flags, $report ) {
160  $flagText = '';
161  if ( $flags ) {
162  $flagText = '[' . implode( $flags, ', ' ) . ']';
163  }
164 
165  $blockedFile = isset( $report['blocked-uri'] ) ? $report['blocked-uri'] : 'n/a';
166  $page = isset( $report['document-uri'] ) ? $report['document-uri'] : 'n/a';
167  $line = isset( $report['line-number'] ) ? ':' . $report['line-number'] : '';
168  $warningText = $flagText .
169  ' Received CSP report: <' . $blockedFile .
170  '> blocked from being loaded on <' . $page . '>' . $line;
171  return $warningText;
172  }
173 
181  private function error( $code, $method ) {
182  $this->log->info( 'Error reading CSP report: ' . $code, [
183  'method' => $method,
184  'user-agent' => $this->getRequest()->getHeader( 'user-agent' )
185  ] );
186  // 500 so it shows up in browser's developer console.
187  $this->dieUsage( "Error processing CSP report: $code", 'cspreport-' . $code, 500 );
188  }
189 
190  public function getAllowedParams() {
191  return [
192  'reportonly' => [
193  ApiBase::PARAM_TYPE => 'boolean',
195  ],
196  'source' => [
197  ApiBase::PARAM_TYPE => 'string',
198  ApiBase::PARAM_DFLT => 'internal',
200  ]
201  ];
202  }
203 
204  public function mustBePosted() {
205  return true;
206  }
207 
208  public function isWriteMode() {
209  return false;
210  }
211 
215  public function isInternal() {
216  return true;
217  }
218 
222  public function isReadMode() {
223  return false;
224  }
225 
231  public function shouldCheckMaxLag() {
232  return false;
233  }
234 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
getResult()
Get the result object.
Definition: ApiBase.php:577
getParameter($paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:702
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:112
$source
isReadMode()
Even if you don't have read rights, we still want your report.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
Api module to receive and log CSP violation reports.
isInternal()
Mark as internal.
IContextSource $context
static parse($value, $options=0)
Decodes a JSON string.
Definition: FormatJson.php:201
getRequest()
Get the WebRequest object.
generateLogLine($flags, $report)
Get text of log line.
getErrorFromStatus($status, &$extraData=null)
Get error (as code, string) from a Status object.
Definition: ApiBase.php:1619
execute()
Logs a content-security-policy violation report from web browser.
const FORCE_ASSOC
If set, treat json objects '{...}' as associative arrays.
Definition: FormatJson.php:64
getConfig()
Get the Config object.
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
shouldCheckMaxLag()
Doesn't touch db, so max lag should be rather irrelavent.
getReport()
Get the report from post body and turn into associative array.
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
Definition: hooks.txt:802
getFlags($report)
Get extra notes about the report.
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
Definition: injection.txt:35
this hook is for auditing only $req
Definition: hooks.txt:1007
const MAX_POST_SIZE
These reports should be small.
$line
Definition: cdb.php:59
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1574
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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
Definition: hooks.txt:1046
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
Definition: logger.txt:5
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
logReport($flags, $logLine, $context)
Log CSP report, with a different severity depending on $flags.
error($code, $method)
Stop processing the request, and output/log an error.
getUser()
Get the User object.
verifyPostBodyOk()
Output an api error if post body is obviously not OK.
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
Definition: hooks.txt:2491