1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<?php
/**
* Copyright © 2015 Brian Wolff
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Logger\LoggerFactory;
/**
* Api module to receive and log CSP violation reports
*
* @ingroup API
*/
class ApiCSPReport extends ApiBase {
private $log;
/**
* These reports should be small. Ignore super big reports out of paranoia
*/
const MAX_POST_SIZE = 8192;
/**
* Logs a content-security-policy violation report from web browser.
*/
public function execute() {
$reportOnly = $this->getParameter( 'reportonly' );
$logname = $reportOnly ? 'csp-report-only' : 'csp';
$this->log = LoggerFactory::getInstance( $logname );
$userAgent = $this->getRequest()->getHeader( 'user-agent' );
$this->verifyPostBodyOk();
$report = $this->getReport();
$flags = $this->getFlags( $report );
$warningText = $this->generateLogLine( $flags, $report );
$this->logReport( $flags, $warningText, [
// XXX Is it ok to put untrusted data into log??
'csp-report' => $report,
'method' => __METHOD__,
'user' => $this->getUser()->getName(),
'user-agent' => $userAgent,
'source' => $this->getParameter( 'source' ),
] );
$this->getResult()->addValue( null, $this->getModuleName(), 'success' );
}
/**
* Log CSP report, with a different severity depending on $flags
* @param array $flags Flags for this report
* @param string $logLine text of log entry
* @param array $context logging context
*/
private function logReport( $flags, $logLine, $context ) {
if ( in_array( 'false-positive', $flags ) ) {
// These reports probably don't matter much
$this->log->debug( $logLine, $context );
} else {
// Normal report.
$this->log->warning( $logLine, $context );
}
}
/**
* Get extra notes about the report.
*
* @param array $report The CSP report
* @return array
*/
private function getFlags( $report ) {
$reportOnly = $this->getParameter( 'reportonly' );
$source = $this->getParameter( 'source' );
$falsePositives = $this->getConfig()->get( 'CSPFalsePositiveUrls' );
$flags = [];
if ( $source !== 'internal' ) {
$flags[] = 'source=' . $source;
}
if ( $reportOnly ) {
$flags[] = 'report-only';
}
if (
( isset( $report['blocked-uri'] ) &&
isset( $falsePositives[$report['blocked-uri']] ) )
|| ( isset( $report['source-file'] ) &&
isset( $falsePositives[$report['source-file']] ) )
) {
// Report caused by Ad-Ware
$flags[] = 'false-positive';
}
return $flags;
}
/**
* Output an api error if post body is obviously not OK.
*/
private function verifyPostBodyOk() {
$req = $this->getRequest();
$contentType = $req->getHeader( 'content-type' );
if ( $contentType !== 'application/json'
&& $contentType !== 'application/csp-report'
) {
$this->error( 'wrongformat', __METHOD__ );
}
if ( $req->getHeader( 'content-length' ) > self::MAX_POST_SIZE ) {
$this->error( 'toobig', __METHOD__ );
}
}
/**
* Get the report from post body and turn into associative array.
*
* @return Array
*/
private function getReport() {
$postBody = $this->getRequest()->getRawInput();
if ( strlen( $postBody ) > self::MAX_POST_SIZE ) {
// paranoia, already checked content-length earlier.
$this->error( 'toobig', __METHOD__ );
}
$status = FormatJson::parse( $postBody, FormatJson::FORCE_ASSOC );
if ( !$status->isGood() ) {
$msg = $status->getErrors()[0]['message'];
if ( $msg instanceof Message ) {
$msg = $msg->getKey();
}
$this->error( $msg, __METHOD__ );
}
$report = $status->getValue();
if ( !isset( $report['csp-report'] ) ) {
$this->error( 'missingkey', __METHOD__ );
}
return $report['csp-report'];
}
/**
* Get text of log line.
*
* @param array $flags of additional markers for this report
* @param array $report the csp report
* @return string Text to put in log
*/
private function generateLogLine( $flags, $report ) {
$flagText = '';
if ( $flags ) {
$flagText = '[' . implode( ', ', $flags ) . ']';
}
$blockedFile = isset( $report['blocked-uri'] ) ? $report['blocked-uri'] : 'n/a';
$page = isset( $report['document-uri'] ) ? $report['document-uri'] : 'n/a';
$line = isset( $report['line-number'] ) ? ':' . $report['line-number'] : '';
$warningText = $flagText .
' Received CSP report: <' . $blockedFile .
'> blocked from being loaded on <' . $page . '>' . $line;
return $warningText;
}
/**
* Stop processing the request, and output/log an error
*
* @param string $code error code
* @param string $method method that made error
* @throws ApiUsageException Always
*/
private function error( $code, $method ) {
$this->log->info( 'Error reading CSP report: ' . $code, [
'method' => $method,
'user-agent' => $this->getRequest()->getHeader( 'user-agent' )
] );
// Return 400 on error for user agents to display, e.g. to the console.
$this->dieWithError(
[ 'apierror-csp-report', wfEscapeWikiText( $code ) ], 'cspreport-' . $code, [], 400
);
}
public function getAllowedParams() {
return [
'reportonly' => [
ApiBase::PARAM_TYPE => 'boolean',
ApiBase::PARAM_DFLT => false
],
'source' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => 'internal',
ApiBase::PARAM_REQUIRED => false
]
];
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return false;
}
/**
* Mark as internal. This isn't meant to be used by normal api users
* @return bool
*/
public function isInternal() {
return true;
}
/**
* Even if you don't have read rights, we still want your report.
* @return bool
*/
public function isReadMode() {
return false;
}
/**
* Doesn't touch db, so max lag should be rather irrelavent.
*
* Also, this makes sure that reports aren't lost during lag events.
* @return bool
*/
public function shouldCheckMaxLag() {
return false;
}
}
|
