MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
30 class ApiCSPReport extends ApiBase {
32  private $log;
37  const MAX_POST_SIZE = 8192;
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' );
48  $this->verifyPostBodyOk();
49  $report = $this->getReport();
50  $flags = $this->getFlags( $report );
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  }
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  }
86  private function getFlags( $report ) {
87  $reportOnly = $this->getParameter( 'reportonly' );
88  $source = $this->getParameter( 'source' );
89  $falsePositives = $this->getConfig()->get( 'CSPFalsePositiveUrls' );
91  $flags = [];
92  if ( $source !== 'internal' ) {
93  $flags[] = 'source=' . $source;
94  }
95  if ( $reportOnly ) {
96  $flags[] = 'report-only';
97  }
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  }
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  }
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  $msg = $status->getErrors()[0]['message'];
141  if ( $msg instanceof Message ) {
142  $msg = $msg->getKey();
143  }
144  $this->error( $msg, __METHOD__ );
145  }
147  $report = $status->getValue();
149  if ( !isset( $report['csp-report'] ) ) {
150  $this->error( 'missingkey', __METHOD__ );
151  }
152  return $report['csp-report'];
153  }
162  private function generateLogLine( $flags, $report ) {
163  $flagText = '';
164  if ( $flags ) {
165  $flagText = '[' . implode( ', ', $flags ) . ']';
166  }
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;
174  return $warningText;
175  }
184  private function error( $code, $method ) {
185  $this->log->info( 'Error reading CSP report: ' . $code, [
186  'method' => $method,
187  'user-agent' => $this->getRequest()->getHeader( 'user-agent' )
188  ] );
189  // Return 400 on error for user agents to display, e.g. to the console.
190  $this->dieWithError(
191  [ 'apierror-csp-report', wfEscapeWikiText( $code ) ], 'cspreport-' . $code, [], 400
192  );
193  }
195  public function getAllowedParams() {
196  return [
197  'reportonly' => [
198  ApiBase::PARAM_TYPE => 'boolean',
200  ],
201  'source' => [
202  ApiBase::PARAM_TYPE => 'string',
203  ApiBase::PARAM_DFLT => 'internal',
205  ]
206  ];
207  }
209  public function mustBePosted() {
210  return true;
211  }
213  public function isWriteMode() {
214  return false;
215  }
221  public function isInternal() {
222  return true;
223  }
229  public function isReadMode() {
230  return false;
231  }
239  public function shouldCheckMaxLag() {
240  return false;
241  }
242 }
IContextSource $context
Definition: ContextSource.php:33
Definition: ContextSource.php:63
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiCSPReport.php:195
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Indicates whether this module requires write mode.
Definition: ApiCSPReport.php:213
(boolean) Is the parameter required?
Definition: ApiBase.php:111
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
Get the result object.
Definition: ApiBase.php:641
Indicates whether this module must be called with a POST request.
Definition: ApiCSPReport.php:209
Definition: ContextSource.php:71
Api module to receive and log CSP violation reports.
Definition: ApiCSPReport.php:30
Definition: ContextSource.php:120
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:37
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
Definition: ApiCSPReport.php:32
Doesn't touch db, so max lag should be rather irrelavent.
Definition: ApiCSPReport.php:239
Mark as internal.
Definition: ApiCSPReport.php:221
Even if you don't have read rights, we still want your report.
Definition: ApiCSPReport.php:229
Get the report from post body and turn into associative array.
Definition: ApiCSPReport.php:132
If set, treat json objects '{...}' as associative arrays.
Definition: FormatJson.php:64
logReport( $flags, $logLine, $context)
Log CSP report, with a different severity depending on $flags.
Definition: ApiCSPReport.php:70
Definition: cdb.php:59
Logs a content-security-policy violation report from web browser.
Definition: ApiCSPReport.php:42
getFlags( $report)
Get extra notes about the report.
Definition: ApiCSPReport.php:86
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
static parse( $value, $options=0)
Decodes a JSON string.
Definition: FormatJson.php:201
this hook is for auditing only $req
Definition: hooks.txt:990
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:865
Output an api error if post body is obviously not OK.
Definition: ApiCSPReport.php:114
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
getParameter( $paramName, $parseLimit=true)
Get a value for the given parameter.
Definition: ApiBase.php:773
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
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
Definition: mwdoc-filter.php:46
error( $code, $method)
Stop processing the request, and output/log an error.
Definition: ApiCSPReport.php:184
These reports should be small.
Definition: ApiCSPReport.php:37
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
generateLogLine( $flags, $report)
Get text of log line.
Definition: ApiCSPReport.php:162