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'] ) ) {
  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                 $hasher = new PasswordHash( 8, false );
 134                 list( , $hash ) = explode( ':', $yourls_user_passwords[ $user ] );
 135                 $hash = str_replace( '!', '$', $hash );
 136                 return ( $hasher->CheckPassword( $submitted_password, $hash ) );
 137         } else if( yourls_has_md5_password( $user ) ) {
 138                 // Stored password is a salted md5 hash: "md5:<$r = rand(10000,99999)>:<md5($r.'thepassword')>"
 139                 list( , $salt, ) = explode( ':', $yourls_user_passwords[ $user ] );
 140                 return( $yourls_user_passwords[ $user ] == 'md5:'.$salt.':'.md5( $salt . $submitted_password ) );
 141         } else {
 142                 // Password stored in clear text
 143                 return( $yourls_user_passwords[ $user ] == $submitted_password );
 144         }
 145 }
 146
 147 /**
 148  * Overwrite plaintext passwords in config file with phpassed versions.
 149  *
 150  * @since 1.7
 151  * @return true if overwrite was successful, an error message otherwise
 152  */
 153 function yourls_hash_passwords_now() {
 154         global $yourls_user_passwords;
 155
 156         if( !is_readable( YOURLS_CONFIGFILE ) )
 157                 return 'cannot read file'; // not sure that can actually happen...
 158
 159         if( !is_writable( YOURLS_CONFIGFILE ) )
 160                 return 'cannot write file';
 161
 162         $configdata = file_get_contents( YOURLS_CONFIGFILE );
 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         $hasher  = new PasswordHash( 8, false );
 168         foreach ( $yourls_user_passwords as $user => $password ) {
 169                 if ( !yourls_has_phpass_password( $user ) && !yourls_has_md5_password( $user ) ) {
 170                         $to_hash++;
 171                         $hash = $hasher->HashPassword( $password );
 172                         // PHP would interpret $ as a variable, so replace it in storage.
 173                         $hash = str_replace( '$', '!', $hash );
 174                         $quotes = "'" . '"';
 175                         $pattern = "/[$quotes]${user}[$quotes]\s*=>\s*[$quotes]" . preg_quote( $password, '-' ) . "[$quotes]/";
 176                         $replace = "'$user' => 'phpass:$hash' /* Password encrypted by YOURLS */ ";
 177                         $count = 0;
 178                         $configdata = preg_replace( $pattern, $replace, $configdata, -1, $count );
 179                         // There should be exactly one replacement. Otherwise, fast fail.
 180                         if ( $count != 1 ) {
 181                                 global $ydb;
 182                                 $ydb->debug_log[] = "Problem with preg_replace for password hash of user $user";
 183                                 return 'preg_replace problem';
 184                         }
 185                 }
 186         }
 187
 188         if( $to_hash == 0 )
 189                 return true; // There was no password to encrypt
 190
 191         $success = file_put_contents( YOURLS_CONFIGFILE, $configdata );
 192         if ( $success === FALSE ) {
 193                 global $ydb;
 194                 $ydb->debug_log[] = "Failed writing to " . YOURLS_CONFIGFILE;
 195                 return 'could not write file';
 196         }
 197         return true;
 198 }
 199
 200 /**
 201  * Check to see if any passwords are stored as cleartext.
 202  *
 203  * @since 1.7
 204  * @return bool true if any passwords are cleartext
 205  */
 206 function yourls_has_cleartext_passwords() {
 207         global $yourls_user_passwords;
 208         foreach ( $yourls_user_passwords as $user => $pwdata ) {
 209                 if ( !yourls_has_md5_password( $user ) && !yourls_has_phpass_password( $user ) ) {
 210                         return true;
 211                 }
 212         }
 213         return false;
 214 }
 215
 216 /**
 217  * Check if a user has a hashed password
 218  *
 219  * Check if a user password is 'md5:[38 chars]'.
 220  * TODO: deprecate this when/if we have proper user management with password hashes stored in the DB
 221  *
 222  * @since 1.7
 223  * @param string $user user login
 224  * @return bool true if password hashed, false otherwise
 225  */
 226 function yourls_has_md5_password( $user ) {
 227         global $yourls_user_passwords;
 228         return(    isset( $yourls_user_passwords[ $user ] )
 229                 && substr( $yourls_user_passwords[ $user ], 0, 4 ) == 'md5:'
 230                     && strlen( $yourls_user_passwords[ $user ] ) == 42 // http://www.google.com/search?q=the+answer+to+life+the+universe+and+everything
 231                    );
 232 }
 233
 234 /**
 235  * Check if a user's password is hashed with PHPASS.
 236  *
 237  * Check if a user password is 'phpass:[lots of chars]'.
 238  * TODO: deprecate this when/if we have proper user management with password hashes stored in the DB
 239  *
 240  * @since 1.7
 241  * @param string $user user login
 242  * @return bool true if password hashed with PHPASS, otherwise false
 243  */
 244 function yourls_has_phpass_password( $user ) {
 245         global $yourls_user_passwords;
 246         return( isset( $yourls_user_passwords[ $user ] )
 247                 && substr( $yourls_user_passwords[ $user ], 0, 7 ) == 'phpass:'
 248         );
 249 }
 250
 251 /**
 252  * Check auth against encrypted COOKIE data. Sets user if applicable, returns bool
 253  *
 254  */
 255 function yourls_check_auth_cookie() {
 256         global $yourls_user_passwords;
 257         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 258                 if ( yourls_salt( $valid_user ) == $_COOKIE['yourls_username'] ) {
 259                         yourls_set_user( $valid_user );
 260                         return true;
 261                 }
 262         }
 263         return false;
 264 }
 265
 266 /**
 267  * Check auth against signature and timestamp. Sets user if applicable, returns bool
 268  *
 269  */
 270 function yourls_check_signature_timestamp() {
 271         // Timestamp in PHP : time()
 272         // Timestamp in JS: parseInt(new Date().getTime() / 1000)
 273         global $yourls_user_passwords;
 274         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 275                 if (
 276                         (
 277                                 md5( $_REQUEST['timestamp'].yourls_auth_signature( $valid_user ) ) == $_REQUEST['signature']
 278                                 or
 279                                 md5( yourls_auth_signature( $valid_user ).$_REQUEST['timestamp'] ) == $_REQUEST['signature']
 280                         )
 281                         &&
 282                         yourls_check_timestamp( $_REQUEST['timestamp'] )
 283                         ) {
 284                         yourls_set_user( $valid_user );
 285                         return true;
 286                 }
 287         }
 288         return false;
 289 }
 290
 291 /**
 292  * Check auth against signature. Sets user if applicable, returns bool
 293  *
 294  */
 295 function yourls_check_signature() {
 296         global $yourls_user_passwords;
 297         foreach( $yourls_user_passwords as $valid_user => $valid_password ) {
 298                 if ( yourls_auth_signature( $valid_user ) == $_REQUEST['signature'] ) {
 299                         yourls_set_user( $valid_user );
 300                         return true;
 301                 }
 302         }
 303         return false;
 304 }
 305
 306 /**
 307  * Generate secret signature hash
 308  *
 309  */
 310 function yourls_auth_signature( $username = false ) {
 311         if( !$username && defined('YOURLS_USER') ) {
 312                 $username = YOURLS_USER;
 313         }
 314         return ( $username ? substr( yourls_salt( $username ), 0, 10 ) : 'Cannot generate auth signature: no username' );
 315 }
 316
 317 /**
 318  * Check if timestamp is not too old
 319  *
 320  */
 321 function yourls_check_timestamp( $time ) {
 322         $now = time();
 323         // Allow timestamp to be a little in the future or the past -- see Issue 766
 324         return yourls_apply_filter( 'check_timestamp', abs( $now - $time ) < YOURLS_NONCE_LIFE, $time );
 325 }
 326
 327 /**
 328  * Store new cookie. No $user will delete the cookie.
 329  *
 330  */
 331 function yourls_store_cookie( $user = null ) {
 332         if( !$user ) {
 333                 $pass = null;
 334                 $time = time() - 3600;
 335         } else {
 336                 global $yourls_user_passwords;
 337                 if( isset($yourls_user_passwords[$user]) ) {
 338                         $pass = $yourls_user_passwords[$user];
 339                 } else {
 340                         die( 'Stealing cookies?' ); // This should never happen
 341                 }
 342                 $time = time() + YOURLS_COOKIE_LIFE;
 343         }
 344
 345         $domain   = yourls_apply_filter( 'setcookie_domain',   parse_url( YOURLS_SITE, 1 ) );
 346         $secure   = yourls_apply_filter( 'setcookie_secure',   yourls_is_ssl() );
 347         $httponly = yourls_apply_filter( 'setcookie_httponly', true );
 348
 349         if ( !headers_sent() ) {
 350                 // Set httponly if the php version is >= 5.2.0
 351                 if( version_compare( phpversion(), '5.2.0', 'ge' ) ) {
 352                         setcookie('yourls_username', yourls_salt( $user ), $time, '/', $domain, $secure, $httponly );
 353                 } else {
 354                         setcookie('yourls_username', yourls_salt( $user ), $time, '/', $domain, $secure );
 355                 }
 356         } else {
 357                 // For some reason cookies were not stored: action to be able to debug that
 358                 yourls_do_action( 'setcookie_failed', $user );
 359         }
 360 }
 361
 362 /**
 363  * Set user name
 364  *
 365  */
 366 function yourls_set_user( $user ) {
 367         if( !defined( 'YOURLS_USER' ) )
 368                 define( 'YOURLS_USER', $user );
 369 }
 370