includes/functions-auth.php

   1 <?php
   2 /**
   3  * Check for valid user via login form or stored cookie. Returns true or an error message
   4  *
   5  */
   6 function yourls_is_valid_user() {
   7         static $valid = false;
   8
   9         if( $valid )
  10                 return true;
  11
  12         // Allow plugins to short-circuit the whole function
  13         $pre = yourls_apply_filter( 'shunt_is_valid_user', null );
  14         if ( null !== $pre ) {
  15                 $valid = ( $pre === true ) ;
  16                 return $pre;
  17         }
  18
  19         // $unfiltered_valid : are credentials valid? Boolean value. It's "unfiltered" to allow plugins to eventually filter it.
  20         $unfiltered_valid = false;
  21
  22         // Logout request
  23         if( isset( $_GET['action'] ) && $_GET['action'] == 'logout' ) {
  24                 yourls_do_action( 'logout' );
  25                 yourls_store_cookie( null );
  26                 return yourls__( 'Logged out successfully' );
  27         }
  28
  29         // Check cookies or login request. Login form has precedence.
  30
  31         yourls_do_action( 'pre_login' );
  32
  33         // Determine auth method and check credentials
  34         if
  35                 // API only: Secure (no login or pwd) and time limited token
  36                 // ?timestamp=12345678&signature=md5(totoblah12345678)
  37                 ( yourls_is_API() &&
  38                   isset( $_REQUEST['timestamp'] ) && !empty($_REQUEST['timestamp'] ) &&
  39                   isset( $_REQUEST['signature'] ) && !empty($_REQUEST['signature'] )
  40                 )
  41                 {
  42                         yourls_do_action( 'pre_login_signature_timestamp' );
  43                         $unfiltered_valid = yourls_check_signature_timestamp();
  44                 }
  45
  46         elseif
  47                 // API only: Secure (no login or pwd)
  48                 // ?signature=md5(totoblah)
  49                 ( yourls_is_API() &&
  50                   !isset( $_REQUEST['timestamp'] ) &&
  51                   isset( $_REQUEST['signature'] ) && !empty( $_REQUEST['signature'] )
  52                 )
  53                 {
  54                         yourls_do_action( 'pre_login_signature' );
  55                         $unfiltered_valid = yourls_check_signature();
  56                 }
  57
  58         elseif
  59                 // API or normal: login with username & pwd
  60                 ( isset( $_REQUEST['username'] ) && isset( $_REQUEST['password'] )
  61                   && !empty( $_REQUEST['username'] ) && !empty( $_REQUEST['password']  ) )
  62                 {
  63                         yourls_do_action( 'pre_login_username_password' );
  64                         $unfiltered_valid = yourls_check_username_password();
  65                 }
  66
  67         elseif
  68                 // Normal only: cookies
  69                 ( !yourls_is_API() &&
  70                   isset( $_COOKIE['yourls_username'] ) )
  71                 {
  72                         yourls_do_action( 'pre_login_cookie' );
  73                         $unfiltered_valid = yourls_check_auth_cookie();
  74                 }
  75
  76         // Regardless of validity, allow plugins to filter the boolean and have final word
  77         $valid = yourls_apply_filter( 'is_valid_user', $unfiltered_valid );
  78
  79         // Login for the win!
  80         if ( $valid ) {
  81                 yourls_do_action( 'login' );
  82
  83                 // (Re)store encrypted cookie if needed
  84                 if ( !yourls_is_API() ) {
  85                         yourls_store_cookie( YOURLS_USER );
  86
  87                         // Login form : redirect to requested URL to avoid re-submitting the login form on page reload
  88                         if( isset( $_REQUEST['username'] ) && isset( $_REQUEST['password'] ) && isset( $_SERVER['REQUEST_URI'] ) ) {
  89                                 $url = $_SERVER['REQUEST_URI'];
  90                                 yourls_redirect( $url );
  91                         }
  92                 }
  93
  94                 // Login successful
  95                 return true;
  96         }
  97
  98         // Login failed
  99         yourls_do_action( 'login_failed' );
 100
 101         if ( isset( $_REQUEST['username'] ) || isset( $_REQUEST['password'] ) ) {
 102                 return yourls__( 'Invalid username or password' );
 103         } else {
 104                 return yourls__( 'Please log in' );
 105         }
 106 }
 107
 108 /**
 109  * Check auth against list of login=>pwd. Sets user if applicable, returns bool
 110  *
 111  */
 112 function yourls_check_username_password() {
 113         global $yourls_user_passwords;
 114         if( isset( $yourls_user_passwords[ $_REQUEST['username'] ] ) && yourls_check_password_hash( $_REQUEST['username'], $_REQUEST['password'] ) ) {
 115                 yourls_set_user( $_REQUEST['username'] );
 116                 return true;
 117         }
 118         return false;
 119 }
 120
 121 /**
 122  * Check a submitted password sent in plain text against stored password which can be a salted hash
 123  *
 124  */
 125 function yourls_check_password_hash( $user, $submitted_password ) {
 126         global $yourls_user_passwords;
 127
 128         if( !isset( $yourls_user_passwords[ $user ] ) )
 129                 return false;
 130
 131         if ( yourls_has_phpass_password( $user ) ) {
 132                 // Stored password is hashed with phpass
 133                 list( , $hash ) = explode( ':', $yourls_user_passwords[ $user ] );
 134                 $hash = str_replace( '!', '$', $hash );
 135                 return ( yourls_phpass_check( $submitted_password, $hash ) );
 136         } else if( yourls_has_md5_password( $user ) ) {
 137                 // Stored password is a salted md5 hash: "md5:<$r = rand(10000,99999)>:<md5($r.'thepassword')>"
 138                 list( , $salt, ) = explode( ':', $yourls_user_passwords[ $user ] );
 139                 return( $yourls_user_passwords[ $user ] == 'md5:'.$salt.':'.md5( $salt . $submitted_password ) );
 140         } else {
 141                 // Password stored in clear text
 142                 return( $yourls_user_passwords[ $user ] == $submitted_password );
 143         }
 144 }
 145
 146 /**
 147  * Overwrite plaintext passwords in config file with phpassed versions.
 148  *
 149  * @since 1.7
 150  * @param string $config_file Full path to file
 151  * @return true if overwrite was successful, an error message otherwise
 152  */
 153 function yourls_hash_passwords_now( $config_file ) {
 154         global $yourls_user_passwords;
 155
 156         if( !is_readable( $config_file ) )
 157                 return 'cannot read file'; // not sure that can actually happen...
 158
 159         if( !is_writable( $config_file ) )
 160                 return 'cannot write file';
 161
 162         $configdata = file_get_contents( $config_file );
 163         if( $configdata == false )
 164                 return 'could not read file';
 165
 166         $to_hash = 0; // keep track of number of passwords that need hashing
 167         foreach ( $yourls_user_passwords as $user => $password ) {
 168                 if ( !yourls_has_phpass_password( $user ) && !yourls_has_md5_password( $user ) ) {
 169                         $to_hash++;
 170                         $hash = yourls_phpass_hash( $password );
 171                         // PHP would interpret $ as a variable, so replace it in storage.
 172                         $hash = str_replace( '$', '!', $hash );
 173                         $quotes = "'" . '"';
 174                         $pattern = "/[$quotes]${user}[$quotes]\s*=>\s*[$quotes]" . preg_quote( $password, '-' ) . "[$quotes]/";
 175                         $replace = "'$user' => 'phpass:$hash' /* Password encrypted by YOURLS */ ";
 176                         $count = 0;
 177                         $configdata = preg_replace( $pattern, $replace, $configdata, -1, $count );
 178                         // There should be exactly one replacement. Otherwise, fast fail.
 179                         if ( $count != 1 ) {
 180                                 global $ydb;
 181                                 $ydb->debug_log[] = "Problem with preg_replace for password hash of user $user";
 182                                 return 'preg_replace problem';
 183                         }
 184                 }
 185         }
 186
 187         if( $to_hash == 0 )
 188                 return true; // There was no password to encrypt
 189
 190         $success = file_put_contents( $config_file, $configdata );
 191         if ( $success === FALSE ) {
 192                 global $ydb;
 193                 $ydb->debug_log[] = "Failed writing to " . $config_file;
 194                 return 'could not write file';
 195         }
 196         return true;
 197 }
 198
 199 /**
 200  * Hash a password using phpass
 201  *
 202  * @since 1.7
 203  * @param string $password password to hash
 204  * @return string hashed password
 205  */
 206 function yourls_phpass_hash( $password ) {
 207         $hasher = yourls_phpass_instance();
 208         return $hasher->HashPassword( $password );
 209 }
 210
 211 /**
 212  * Check a clear password against a phpass hash
 213  *
 214  * @since 1.7
 215  * @param string $password clear (eg submitted in a form) password
 216  * @param string $hash hash supposedly generated by phpass
 217  * @return bool true if the hash matches the password once hashed by phpass, false otherwise
 218  */
 219 function yourls_phpass_check( $password, $hash ) {
 220         $hasher = yourls_phpass_instance();
 221         return $hasher->CheckPassword( $password, $hash );
 222 }
 223
 224 /**
 225  * Helper function: create new instance or return existing instance of phpass class
 226  *
 227  * @since 1.7
 228  * @param int $iteration iteration count - 8 is default in phpass
 229  * @param bool $portable flag to force portable (cross platform and system independant) hashes - false to use whatever the system can do best
 230  * @return object a PasswordHash instance
 231  */
 232 function yourls_phpass_instance( $iteration = 8, $portable = false ) {
 233         $iteration = yourls_apply_filter( 'phpass_new_instance_iteration', $iteration );
 234         $portable  = yourls_apply_filter( 'phpass_new_instance_portable', $portable );
 235
 236         if( !class_exists( 'PasswordHash' ) ) {
 237                 require_once( YOURLS_INC.'/phpass/PasswordHash.php' );
 238         }
 239
 240         static $instance = false;
 241         if( $instance == false ) {
 242                 $instance = new PasswordHash( $iteration, $portable );
 243         }
 244
 245         return $instance;
 246 }
 247
 248
 249 /**
 250  * Check to see if any passwords are stored as cleartext.
 251  *
 252  * @since 1.7
 253  * @return bool true if any passwords are cleartext
 254  */
 255 function yourls_has_cleartext_passwords() {
 256         global $yourls_user_passwords;
 257         foreach ( $yourls_user_passwords as $user => $pwdata ) {
 258                 if ( !yourls_has_md5_password( $user ) && !yourls_has_phpass_password( $user ) ) {
 259                         return true;
 260                 }
 261         }
 262         return false;
 263 }
 264
 265 /**
 266  * Check if a user has a hashed password
 267  *
 268  * Check if a user password is 'md5:[38 chars]'.
 269  * TODO: deprecate this when/if we have proper user management with password hashes stored in the DB
 270  *
 271  * @since 1.7
 272  * @param string $user user login
 273  * @return bool true if password hashed, false otherwise
 274  */
 275 function yourls_has_md5_password( $user ) {
 276         global $yourls_user_passwords;
 277         return(    isset( $yourls_user_passwords[ $user ] )
 278                 && substr( $yourls_user_passwords[ $user ], 0, 4 ) == 'md5:'
 279                     && strlen( $yourls_user_passwords[ $user ] ) == 42 // http://www.google.com/search?q=the+answer+to+life+the+universe+and+everything
 280                    );
 281 }
 282
 283 /**
 284  * Check if a user's password is hashed with PHPASS.
 285  *
 286  * Check if a user password is 'phpass:[lots of chars]'.
 287  * TODO: deprecate this when/if we have proper user management with password hashes stored in the DB
 288  *
 289  * @since 1.7
 290  * @param string $user user login
 291  * @return bool true if password hashed with PHPASS, otherwise false
 292  */
 293 function yourls_has_phpass_password( $user ) {
 294         global $yourls_user_passwords;
 295         return( isset( $yourls_user_passwords[ $user ] )
 296                 && substr( $yourls_user_passwords[ $user ], 0, 7 ) == 'phpass:'
 297         );
 298 }
 299
 300 /**
 301  * Check auth against encrypted COOKIE data. Sets user if applicable, returns bool
 302  *
 303  */
 304 function yourls_check_auth_cookie() {
 305         global $yourls_user_passwords;
 306         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 307                 if ( yourls_salt( $valid_user ) == $_COOKIE['yourls_username'] ) {
 308                         yourls_set_user( $valid_user );
 309                         return true;
 310                 }
 311         }
 312         return false;
 313 }
 314
 315 /**
 316  * Check auth against signature and timestamp. Sets user if applicable, returns bool
 317  *
 318  */
 319 function yourls_check_signature_timestamp() {
 320         // Timestamp in PHP : time()
 321         // Timestamp in JS: parseInt(new Date().getTime() / 1000)
 322         global $yourls_user_passwords;
 323         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 324                 if (
 325                         (
 326                                 md5( $_REQUEST['timestamp'].yourls_auth_signature( $valid_user ) ) == $_REQUEST['signature']
 327                                 or
 328                                 md5( yourls_auth_signature( $valid_user ).$_REQUEST['timestamp'] ) == $_REQUEST['signature']
 329                         )
 330                         &&
 331                         yourls_check_timestamp( $_REQUEST['timestamp'] )
 332                         ) {
 333                         yourls_set_user( $valid_user );
 334                         return true;
 335                 }
 336         }
 337         return false;
 338 }
 339
 340 /**
 341  * Check auth against signature. Sets user if applicable, returns bool
 342  *
 343  */
 344 function yourls_check_signature() {
 345         global $yourls_user_passwords;
 346         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 347                 if ( yourls_auth_signature( $valid_user ) == $_REQUEST['signature'] ) {
 348                         yourls_set_user( $valid_user );
 349                         return true;
 350                 }
 351         }
 352         return false;
 353 }
 354
 355 /**
 356  * Generate secret signature hash
 357  *
 358  */
 359 function yourls_auth_signature( $username = false ) {
 360         if( !$username && defined('YOURLS_USER') ) {
 361                 $username = YOURLS_USER;
 362         }
 363         return ( $username ? substr( yourls_salt( $username ), 0, 10 ) : 'Cannot generate auth signature: no username' );
 364 }
 365
 366 /**
 367  * Check if timestamp is not too old
 368  *
 369  */
 370 function yourls_check_timestamp( $time ) {
 371         $now = time();
 372         // Allow timestamp to be a little in the future or the past -- see Issue 766
 373         return yourls_apply_filter( 'check_timestamp', abs( $now - $time ) < YOURLS_NONCE_LIFE, $time );
 374 }
 375
 376 /**
 377  * Store new cookie. No $user will delete the cookie.
 378  *
 379  */
 380 function yourls_store_cookie( $user = null ) {
 381         if( !$user ) {
 382                 $pass = null;
 383                 $time = time() - 3600;
 384         } else {
 385                 global $yourls_user_passwords;
 386                 if( isset($yourls_user_passwords[$user]) ) {
 387                         $pass = $yourls_user_passwords[$user];
 388                 } else {
 389                         die( 'Stealing cookies?' ); // This should never happen
 390                 }
 391                 $time = time() + YOURLS_COOKIE_LIFE;
 392         }
 393
 394         $domain   = yourls_apply_filter( 'setcookie_domain',   parse_url( YOURLS_SITE, 1 ) );
 395         $secure   = yourls_apply_filter( 'setcookie_secure',   yourls_is_ssl() );
 396         $httponly = yourls_apply_filter( 'setcookie_httponly', true );
 397
 398         if ( !headers_sent() ) {
 399                 // Set httponly if the php version is >= 5.2.0
 400                 if( version_compare( phpversion(), '5.2.0', 'ge' ) ) {
 401                         setcookie('yourls_username', yourls_salt( $user ), $time, '/', $domain, $secure, $httponly );
 402                 } else {
 403                         setcookie('yourls_username', yourls_salt( $user ), $time, '/', $domain, $secure );
 404                 }
 405         } else {
 406                 // For some reason cookies were not stored: action to be able to debug that
 407                 yourls_do_action( 'setcookie_failed', $user );
 408         }
 409 }
 410
 411 /**
 412  * Set user name
 413  *
 414  */
 415 function yourls_set_user( $user ) {
 416         if( !defined( 'YOURLS_USER' ) )
 417                 define( 'YOURLS_USER', $user );
 418 }
 419