authenticator/authenticator.php at master · inpsyde/authenticator · GitHub

History

executable file

497 lines (419 loc) · 10.7 KB

Raw

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

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

<?php

/**

* Plugin Name: Authenticator

* Plugin URI: https://wordpress.org/plugins/authenticator/

* Description: This plugin allows you to make your WordPress site accessible to logged in users only. In other words, to view your site they have to create or have an account on your site and be logged in. No configuration necessary, simply activating - that's all.

* Author: Inpsyde GmbH

* Version: 1.3.1

* Author URI: https://github.com/bueltge/authenticator

* License: GPLv3+

* License URI: ./assets/license.txt

* Text Domain: authenticator

// check for uses in WP

if ( ! function_exists( 'add_filter' ) ) {

echo "Hi there! I'm just a part of plugin, not much I can do when called directly.";

exit;

}

spl_autoload_register( array( 'Authenticator', 'load_classes' ) );

register_uninstall_hook( __FILE__, array( 'Authenticator', 'uninstall' ) );

//start on a lower priority to allow other plugins to place their hooks to the Authenticator-API

add_action( 'plugins_loaded', array( 'Authenticator', 'get_instance' ), 11 );

class Authenticator {

/**

* option key

* @since 1.1.0

* @const string

const KEY = 'authenticator_options';

/**

* textdomain

* @since 1.1.0

* @const string

const TEXTDOMAIN = 'authenticator';

/**

* Version

* @since 1.1.0

* @const string

const VERSION = '1.3.1';

/**

* absolute path to this directory

* @since 1.1.0

* @var string

public static $dir = '';

/**

* absolute URL to this directory

* @since 1.1.0

* @var string

public static $url = '';

/**

* instance of self

* @var Authenticator

private static $instance = null;

/**

* Array for pages, there are checked for exclude the redirect

* admin-ajax.php is handled separately

public static $exclude_pagenows = array( 'wp-login.php', 'wp-register.php' );

/**

* Array for posts (post_title), there are checked for exclude the redirect

* Used for custom login form, default is empty

* @since 1.1.0

public static $exclude_posts = array();

/**

* Array for actions, which are allowed with wp-ajax

* @since 1.1.0

public static $exclude_ajax_actions = array();

/**

* options

* @var array

protected static $options = array();

/**

* instance of settings handling class

* @var Authenticator_Settings

public $settings;

/**

* @type Authenticator_Protect_Upload

public $protect_uploads;

/**

* get the instance

* @since 1.1.0

* @return Authenticator

public static function get_instance() {

if ( ! self::$instance instanceof self ) {

self::$instance = new self;

}

return self::$instance;

}

/**

* Constructor, init redirect on defined hooks

* @since 0.4.0

public function __construct() {

self::$dir = plugin_dir_path( __FILE__ );

self::$url = plugins_url( '', __FILE__ );

$this->localize();

// allow other plugins to change the list of excluded (non redirected) urls

self::$exclude_pagenows = apply_filters( 'authenticator_exclude_pagenows', self::$exclude_pagenows );

// allow other plugins to change the list of excluded (non redirected) urls

self::$exclude_posts = apply_filters( 'authenticator_exclude_posts', self::$exclude_posts );

// allow other plugins to change the list of excluded (non redirected) ajax actions

self::$exclude_ajax_actions = apply_filters( 'authenticator_exclude_ajax_actions', self::$exclude_ajax_actions );

// check if the user needs to authenticate

$authenticate_method = $this->get_authenticate_method();

if ( 'redirect' === $authenticate_method ) {

add_action( 'template_redirect', array( __CLASS__, $authenticate_method ) );

} elseif ( 'authenticate_ajax' === $authenticate_method ) {

add_action( 'admin_init', array( __CLASS__, $authenticate_method ) );

}

# set cookie lifetime

add_filter( 'auth_cookie_expiration', array( $this, 'filter_cookie_lifetime' ) );

add_action( 'admin_init', array( $this, 'init_settings' ) );

add_filter( 'authenticator_get_options', array( $this, 'get_options' ) );

self::$options = get_option( self::KEY, array() );

add_action( 'init', array( $this, 'protect_upload' ) );

add_action( 'init', array( $this, 'disable_xmlrpc' ) );

add_action( 'init', array( $this, 'authenticate_rest_api') );

add_action( 'login_footer', array( $this, 'remove_back_to_blog_link' ) );

}

/**

* get the method to authenticate or null

* if no authentication is required

* @since 1.1.0

* @global $pagenow

* @return string|null

public function get_authenticate_method() {

if ( ! isset( $GLOBALS[ 'pagenow' ] ) ) {

return 'redirect';

}

//shorthand

$p = $GLOBALS[ 'pagenow' ];

// exclude some pagenows ?

if ( in_array( $p, self::$exclude_pagenows, true ) ) {

return null;

}

if ( 'admin-ajax.php' === $p ) {

if ( isset( $_REQUEST[ 'action' ] ) && in_array( $_REQUEST[ 'action' ], self::$exclude_ajax_actions, false ) ) {

return null;

}

return 'authenticate_ajax';

}

return 'redirect';

}

/**

* load the language files

* @since 1.1.0

* @return void

public function localize() {

load_plugin_textdomain(

'authenticator',

FALSE,

dirname( plugin_basename( __FILE__ ) ) . '/language'

);

}

/**

* init the settings api

* @since 1.1.0

* @return void

public function init_settings() {

$this->settings = new Authenticator_Settings();

}

/**

* Init to protect uploads

* @since 10/11/2012

* @return void

public function protect_upload() {

$this->protect_uploads = new Authenticator_Protect_Upload();

}

/**

* Get redirect to login-page, if user not logged in blogs of network and single install

* @since 0.4.2

* @return void

public static function redirect() {

if ( apply_filters( 'authenticator_bypass', FALSE ) ) {

return;

}

if ( is_feed() ) {

if ( TRUE === apply_filters( 'authenticator_bypass_feed_auth', FALSE ) ) {

return;

}

switch ( self::$options[ 'feed_authentication' ] ) {

case 'http' :

self::http_auth_feed();

return;

break;

case 'token' :

if ( isset( $_GET[ self::$options[ 'auth_token' ] ] ) ) {

return;

}

self::_exit_403();

break;

case 'none' :

default :

# nothing to do

break;

}

/**

* Checks if a user is logged in or has rights on the blog in multisite,

* if not redirects them to the login page

if ( ! self::authenticate_user() &&

( ! is_singular() || ! in_array(

get_the_title(),

apply_filters( 'authenticator_exclude_posts', self::$exclude_posts),

true ) )

) {

$reauth =

( ! current_user_can( 'read' )

&& function_exists( 'is_multisite' )

&& is_multisite() );

nocache_headers();

wp_redirect(

wp_login_url( $_SERVER[ 'REQUEST_URI' ], $reauth ),

$status = 302

);

exit();

}

/**

* checks if the current visitor is logged in and has the

* permission to 'read' this blog

* @since 1.1.0

* @return bool

public static function authenticate_user() {

# user must reauth when we are in multisite

# and he has not the permission to 'read'

$reauth = ( ! current_user_can( 'read' ) &&

function_exists( 'is_multisite' ) &&

is_multisite() );

return is_user_logged_in() && ! $reauth;

}

/**

* checks for authenticated requests on the ajax-interface

* @wp_hook admin_init

* @since 1.1.0

* @return void

public static function authenticate_ajax() {

if ( ! self::authenticate_user() ) {

self::_exit_403();

}

/**

* authenticate users requesting feeds via HTTP Basic auth

* @since 1.1.0

* @return void

protected static function http_auth_feed() {

$auth = new HTTP_Auth( 'Feed of ' . get_bloginfo( 'name' ) );

$user = $auth->get_user();

$user = wp_authenticate( $user[ 'name' ], $user[ 'pass' ] );

if ( ! is_a( $user, 'WP_User' ) || ! user_can( $user, 'read' ) ) {

$auth->auth_required();

}

/**

* get the cookie lifetime if set

* @wp-hook auth_cookie_expiration

* @param int $default_lifetime

* @return int

public function filter_cookie_lifetime( $default_lifetime ) {

if ( ( int ) self::$options[ 'cookie_lifetime' ] > 0 ) {

/** @noinspection SummerTimeUnsafeTimeManipulationInspection */

return 60 * 60 * 24 * ( int ) self::$options[ 'cookie_lifetime' ];

}

return $default_lifetime;

}

/**

* disable_xmlrpc dependend to the setting

* @since 1.1.0

* @wp-hook init

* @return void

public function disable_xmlrpc() {

if ( ! defined( 'XMLRPC_REQUEST' ) ) {

return;

}

if ( ! empty( self::$options[ 'disable_xmlrpc' ] )

&& '1' === self::$options[ 'disable_xmlrpc' ]

) {

add_filter( 'xmlrpc_enabled', '__return_false' );

}

/**

* authenticate_rest_api

* @since 1.2.3

* @wp-hook rest_authentication_errors

* @return void

public function authenticate_rest_api() {

if ( has_filter('rest_authentication_errors') && ! self::authenticate_user() ) {

add_action( 'rest_authentication_errors', function() {

return new WP_Error(

'rest_cannot_access',

esc_attr__( 'Only authenticated users can access the REST API.', 'disable-json-api' ),

array( 'status' => rest_authorization_required_code() )

);

});

}

/**

* get the options

* @return string

public function get_options() {

return self::$options;

}

/**

* Remove Back to Blog link

* Not useful, only a loop with rewrite

* @since 1.1.0

* @return void

public function remove_back_to_blog_link() {

var link = document.getElementById('backtoblog');

link.parentNode.removeChild(link);

</script>

<?php

}

/**

* just exit

* @since 1.1.0

* @return void

public static function _exit_403() {

$protocol = 'HTTP/1.1' === $_SERVER[ 'SERVER_PROTOCOL' ]

? 'HTTP/1.1'

: 'HTTP/1.0';

header( $protocol . ' 403 Forbidden' );

exit( '<h1>403 Forbidden</h1>' );

}

/**

* autoloader

* @since 1.1.0

* @param string $class_name

* @return void

public static function load_classes( $class_name ) {

$file_name = __DIR__ . '/inc/class-' . $class_name . '.php';

if ( file_exists( $file_name ) ) {

/** @noinspection PhpIncludeInspection */

require_once $file_name;

}

/**

* uninstall routine

* @since 1.1.0

* @global $wpdb

* @return void

public static function uninstall() {

global $wpdb;

ignore_user_abort( - 1 );

if ( is_network_admin() && isset( $wpdb->blogs ) ) {

$blogs = $wpdb->get_results(

'SELECT blog_id FROM ' .

$wpdb->blogs,

ARRAY_A

);

foreach ( $blogs as $row ) {

$id = ( int ) $row[ 'blog_id' ];

delete_blog_option( $id, self::KEY );

}

return;

}

delete_option( self::KEY );

}

} // end class

authenticator/authenticator.php at master · inpsyde/authenticator · GitHub

Uh oh!

Expand file tree

Breadcrumbs

authenticator.php

Latest commit

History

Breadcrumbs

authenticator.php

File metadata and controls