3 * Image authorisation script
5 * To use this, see https://www.mediawiki.org/wiki/Manual:Image_Authorization
7 * - Set $wgUploadDirectory to a non-public directory (not web accessible)
8 * - Set $wgUploadPath to point to this file
12 * - Set $wgImgAuthDetails = true if you want the reason the access was denied messages to
13 * be displayed instead of just the 403 error (doesn't work on IE anyway),
14 * otherwise it will only appear in error logs
16 * For security reasons, you usually don't want your user to know *why* access was denied,
17 * just that it was. If you want to change this, you can set $wgImgAuthDetails to 'true'
18 * in localsettings.php and it will give the user the reason why access was denied.
20 * Your server needs to support REQUEST_URI or PATH_INFO; CGI-based
21 * configurations sometimes don't.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
41 define( 'MW_NO_OUTPUT_COMPRESSION', 1 );
42 require __DIR__
. '/includes/WebStart.php';
44 # Set action base paths so that WebRequest::getPathInfo()
45 # recognizes the "X" as the 'title' in ../img_auth.php/X urls.
46 $wgArticlePath = false; # Don't let a "/*" article path clober our action path
47 $wgActionPaths = [ "$wgUploadPath/" ];
51 $mediawiki = new MediaWiki();
52 $mediawiki->doPostOutputShutdown( 'fast' );
54 function wfImageAuthMain() {
55 global $wgImgAuthUrlPathMap;
56 $permissionManager = \MediaWiki\MediaWikiServices
::getInstance()->getPermissionManager();
58 $request = RequestContext
::getMain()->getRequest();
59 $publicWiki = in_array( 'read', $permissionManager->getGroupPermissions( [ '*' ] ), true );
61 // Get the requested file path (source file or thumbnail)
62 $matches = WebRequest
::getPathInfo();
63 if ( !isset( $matches['title'] ) ) {
64 wfForbidden( 'img-auth-accessdenied', 'img-auth-nopathinfo' );
67 $path = $matches['title'];
68 if ( $path && $path[0] !== '/' ) {
69 // Make sure $path has a leading /
73 // Check for T30235: QUERY_STRING overriding the correct extension
75 $extension = FileBackend
::extensionFromPath( $path, 'rawcase' );
76 if ( $extension != '' ) {
77 $whitelist[] = $extension;
79 if ( !$request->checkUrlExtension( $whitelist ) ) {
83 $user = RequestContext
::getMain()->getUser();
85 // Various extensions may have their own backends that need access.
86 // Check if there is a special backend and storage base path for this file.
87 foreach ( $wgImgAuthUrlPathMap as $prefix => $storageDir ) {
88 $prefix = rtrim( $prefix, '/' ) . '/'; // implicit trailing slash
89 if ( strpos( $path, $prefix ) === 0 ) {
90 $be = FileBackendGroup
::singleton()->backendFromPath( $storageDir );
91 $filename = $storageDir . substr( $path, strlen( $prefix ) ); // strip prefix
92 // Check basic user authorization
93 if ( !$user->isAllowed( 'read' ) ) {
94 wfForbidden( 'img-auth-accessdenied', 'img-auth-noread', $path );
97 if ( $be->fileExists( [ 'src' => $filename ] ) ) {
98 wfDebugLog( 'img_auth', "Streaming `" . $filename . "`." );
99 $be->streamFile( [ 'src' => $filename ],
100 [ 'Cache-Control: private', 'Vary: Cookie' ] );
102 wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $path );
108 // Get the local file repository
109 $repo = RepoGroup
::singleton()->getRepo( 'local' );
110 $zone = strstr( ltrim( $path, '/' ), '/', true );
112 // Get the full file storage path and extract the source file name.
113 // (e.g. 120px-Foo.png => Foo.png or page2-120px-Foo.png => Foo.png).
114 // This only applies to thumbnails/transcoded, and each of them should
115 // be under a folder that has the source file name.
116 if ( $zone === 'thumb' ||
$zone === 'transcoded' ) {
117 $name = wfBaseName( dirname( $path ) );
118 $filename = $repo->getZonePath( $zone ) . substr( $path, strlen( "/" . $zone ) );
119 // Check to see if the file exists
120 if ( !$repo->fileExists( $filename ) ) {
121 wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $filename );
125 $name = wfBaseName( $path ); // file is a source file
126 $filename = $repo->getZonePath( 'public' ) . $path;
127 // Check to see if the file exists and is not deleted
128 $bits = explode( '!', $name, 2 );
129 if ( substr( $path, 0, 9 ) === '/archive/' && count( $bits ) == 2 ) {
130 $file = $repo->newFromArchiveName( $bits[1], $name );
132 $file = $repo->newFile( $name );
134 if ( !$file->exists() ||
$file->isDeleted( File
::DELETED_FILE
) ) {
135 wfForbidden( 'img-auth-accessdenied', 'img-auth-nofile', $filename );
140 $headers = []; // extra HTTP headers to send
142 $title = Title
::makeTitleSafe( NS_FILE
, $name );
144 if ( !$publicWiki ) {
145 // For private wikis, run extra auth checks and set cache control headers
146 $headers['Cache-Control'] = 'private';
147 $headers['Vary'] = 'Cookie';
149 if ( !$title instanceof Title
) { // files have valid titles
150 wfForbidden( 'img-auth-accessdenied', 'img-auth-badtitle', $name );
154 // Run hook for extension authorization plugins
155 /** @var array $result */
157 if ( !Hooks
::run( 'ImgAuthBeforeStream', [ &$title, &$path, &$name, &$result ] ) ) {
158 wfForbidden( $result[0], $result[1], array_slice( $result, 2 ) );
162 // Check user authorization for this title
163 // Checks Whitelist too
165 if ( !$permissionManager->userCan( 'read', $user, $title ) ) {
166 wfForbidden( 'img-auth-accessdenied', 'img-auth-noread', $name );
171 if ( isset( $_SERVER['HTTP_RANGE'] ) ) {
172 $headers['Range'] = $_SERVER['HTTP_RANGE'];
174 if ( isset( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
175 $headers['If-Modified-Since'] = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
178 if ( $request->getCheck( 'download' ) ) {
179 $headers['Content-Disposition'] = 'attachment';
182 // Allow modification of headers before streaming a file
183 Hooks
::run( 'ImgAuthModifyHeaders', [ $title->getTitleValue(), &$headers ] );
185 // Stream the requested file
186 list( $headers, $options ) = HTTPFileStreamer
::preprocessHeaders( $headers );
187 wfDebugLog( 'img_auth', "Streaming `" . $filename . "`." );
188 $repo->streamFileWithStatus( $filename, $headers, $options );
192 * Issue a standard HTTP 403 Forbidden header ($msg1-a message index, not a message) and an
193 * error message ($msg2, also a message index), (both required) then end the script
194 * subsequent arguments to $msg2 will be passed as parameters only for replacing in $msg2
195 * @param string $msg1
196 * @param string $msg2
197 * @param mixed ...$args To pass as params to wfMessage() with $msg2. Either variadic, or a single
200 function wfForbidden( $msg1, $msg2, ...$args ) {
201 global $wgImgAuthDetails;
203 $args = ( isset( $args[0] ) && is_array( $args[0] ) ) ?
$args[0] : $args;
205 $msgHdr = wfMessage( $msg1 )->escaped();
206 $detailMsgKey = $wgImgAuthDetails ?
$msg2 : 'badaccess-group0';
207 $detailMsg = wfMessage( $detailMsgKey, $args )->escaped();
209 wfDebugLog( 'img_auth',
210 "wfForbidden Hdr: " . wfMessage( $msg1 )->inLanguage( 'en' )->text() . " Msg: " .
211 wfMessage( $msg2, $args )->inLanguage( 'en' )->text()
214 HttpStatus
::header( 403 );
215 header( 'Cache-Control: no-cache' );
216 header( 'Content-Type: text/html; charset=utf-8' );
221 <meta charset="UTF-8" />
222 <title>$msgHdr</title>