3 * Copyright © 2015 Brian Wolff
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Logger\LoggerFactory
;
26 * Api module to receive and log CSP violation reports
30 class ApiCSPReport
extends ApiBase
{
35 * These reports should be small. Ignore super big reports out of paranoia
37 const MAX_POST_SIZE
= 8192;
40 * Logs a content-security-policy violation report from web browser.
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, $userAgent );
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' ),
61 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
65 * Log CSP report, with a different severity depending on $flags
66 * @param array $flags Flags for this report
67 * @param string $logLine text of log entry
68 * @param array $context logging context
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 );
76 $this->log
->warning( $logLine, $context );
81 * Get extra notes about the report.
83 * @param array $report The CSP report
84 * @param string $userAgent
87 private function getFlags( $report, $userAgent ) {
88 $reportOnly = $this->getParameter( 'reportonly' );
89 $source = $this->getParameter( 'source' );
90 $falsePositives = $this->getConfig()->get( 'CSPFalsePositiveUrls' );
93 if ( $source !== 'internal' ) {
94 $flags[] = 'source=' . $source;
97 $flags[] = 'report-only';
102 ContentSecurityPolicy
::falsePositiveBrowser( $userAgent ) &&
103 $report['blocked-uri'] === "self"
106 isset( $report['blocked-uri'] ) &&
107 isset( $falsePositives[$report['blocked-uri']] )
110 isset( $report['source-file'] ) &&
111 isset( $falsePositives[$report['source-file']] )
114 // False positive due to:
115 // https://bugzilla.mozilla.org/show_bug.cgi?id=1026520
117 $flags[] = 'false-positive';
123 * Output an api error if post body is obviously not OK.
125 private function verifyPostBodyOk() {
126 $req = $this->getRequest();
127 $contentType = $req->getHeader( 'content-type' );
128 if ( $contentType !== 'application/json'
129 && $contentType !== 'application/csp-report'
131 $this->error( 'wrongformat', __METHOD__
);
133 if ( $req->getHeader( 'content-length' ) > self
::MAX_POST_SIZE
) {
134 $this->error( 'toobig', __METHOD__
);
139 * Get the report from post body and turn into associative array.
143 private function getReport() {
144 $postBody = $this->getRequest()->getRawInput();
145 if ( strlen( $postBody ) > self
::MAX_POST_SIZE
) {
146 // paranoia, already checked content-length earlier.
147 $this->error( 'toobig', __METHOD__
);
149 $status = FormatJson
::parse( $postBody, FormatJson
::FORCE_ASSOC
);
150 if ( !$status->isGood() ) {
151 $msg = $status->getErrors()[0]['message'];
152 if ( $msg instanceof Message
) {
153 $msg = $msg->getKey();
155 $this->error( $msg, __METHOD__
);
158 $report = $status->getValue();
160 if ( !isset( $report['csp-report'] ) ) {
161 $this->error( 'missingkey', __METHOD__
);
163 return $report['csp-report'];
167 * Get text of log line.
169 * @param array $flags of additional markers for this report
170 * @param array $report the csp report
171 * @return string Text to put in log
173 private function generateLogLine( $flags, $report ) {
176 $flagText = '[' . implode( ', ', $flags ) . ']';
179 $blockedFile = isset( $report['blocked-uri'] ) ?
$report['blocked-uri'] : 'n/a';
180 $page = isset( $report['document-uri'] ) ?
$report['document-uri'] : 'n/a';
181 $line = isset( $report['line-number'] ) ?
':' . $report['line-number'] : '';
182 $warningText = $flagText .
183 ' Received CSP report: <' . $blockedFile .
184 '> blocked from being loaded on <' . $page . '>' . $line;
189 * Stop processing the request, and output/log an error
191 * @param string $code error code
192 * @param string $method method that made error
193 * @throws ApiUsageException Always
195 private function error( $code, $method ) {
196 $this->log
->info( 'Error reading CSP report: ' . $code, [
198 'user-agent' => $this->getRequest()->getHeader( 'user-agent' )
200 // Return 400 on error for user agents to display, e.g. to the console.
202 [ 'apierror-csp-report', wfEscapeWikiText( $code ) ], 'cspreport-' . $code, [], 400
206 public function getAllowedParams() {
209 ApiBase
::PARAM_TYPE
=> 'boolean',
210 ApiBase
::PARAM_DFLT
=> false
213 ApiBase
::PARAM_TYPE
=> 'string',
214 ApiBase
::PARAM_DFLT
=> 'internal',
215 ApiBase
::PARAM_REQUIRED
=> false
220 public function mustBePosted() {
224 public function isWriteMode() {
229 * Mark as internal. This isn't meant to be used by normal api users
232 public function isInternal() {
237 * Even if you don't have read rights, we still want your report.
240 public function isReadMode() {
245 * Doesn't touch db, so max lag should be rather irrelavent.
247 * Also, this makes sure that reports aren't lost during lag events.
250 public function shouldCheckMaxLag() {