1: <?php
  2: /**
  3: * The authentication handling plugins can be used by the Session class to
  4: * provide authentication.
  5: *
  6: * Each authenticate hook needs to:
  7: *   - Accept a username / password
  8: *   - Confirm the username / password are correct
  9: *   - Create (or update) a 'usr' record in our database
 10: *   - Return the 'usr' record as an object
 11: *   - Return === false when authentication fails
 12: *
 13: * It can expect that:
 14: *   - Configuration data will be in $c->authenticate_hook['config'], which might be an array, or whatever is needed.
 15: *
 16: * In order to be called:
 17: *   - This file should be included
 18: *   - $c->authenticate_hook['call'] should be set to the name of the plugin
 19: *   - $c->authenticate_hook['config'] should be set up with any configuration data for the plugin
 20: *
 21: * @package   davical
 22: * @subpackage   authentication
 23: * @author    Andrew McMillan <andrew@mcmillan.net.nz>
 24: * @copyright Catalyst IT Ltd, Morphoss Ltd
 25: * @license   http://gnu.org/copyleft/gpl.html GNU GPL v2 or later
 26: */
 27: 
 28: require_once("DataUpdate.php");
 29: 
 30: if ( !function_exists('auth_functions_deprecated') ) {
 31:   /**
 32:    * Warn about deprecated auth functions
 33:    */
 34:   function auth_functions_deprecated( $method, $message = null ) {
 35:       $stack = debug_backtrace();
 36:       array_shift($stack);
 37:       dbg_error_log("ERROR", " auth-functions: Call to deprecated routine '%s'%s", $method, (isset($message)?': '.$message:'') );
 38:       foreach( $stack AS $k => $v ) {
 39:         dbg_error_log( 'ERROR', ' auth-functions: Deprecated call from line %4d of %s', $v['line'], $v['file']);
 40:       }
 41:   }
 42: }
 43: 
 44: /**
 45:  * @deprecated
 46:  */
 47: function getUserByName( $username, $use_cache=true ) {
 48:   auth_functions_deprecated('getUserByName','replaced by Principal class');
 49:   return new Principal('username', $username, $use_cache);
 50: }
 51: 
 52: /**
 53:  * @deprecated
 54:  */
 55: function getUserByEMail( $email, $use_cache = true ) {
 56:   auth_functions_deprecated('getUserByEMail','replaced by Principal class');
 57:   return new Principal('email', $email, $use_cache);
 58: }
 59: 
 60: /**
 61:  * @deprecated
 62:  */
 63: function getUserByID( $user_no, $use_cache = true ) {
 64:   auth_functions_deprecated('getUserByID','replaced by Principal class');
 65:   return new Principal('user_no', $user_no, $use_cache);
 66: }
 67: 
 68: /**
 69:  * @deprecated
 70:  */
 71: function getPrincipalByID( $principal_id, $use_cache = true ) {
 72:   auth_functions_deprecated('getPrincipalByID','replaced by Principal class');
 73:   return new Principal('principal_id', $principal_id, $use_cache);
 74: }
 75: 
 76: 
 77: /**
 78: * Creates some default home collections for the user.
 79: * @param string $username The username of the user we are creating relationships for.
 80: */
 81: function CreateHomeCollections( $username, $defult_timezone = null ) {
 82:   global $session, $c;
 83: 
 84:   if ( !isset($c->default_collections) )
 85:   {
 86:     $c->default_collections = array();
 87: 
 88:     if( !empty($c->home_calendar_name) )
 89:       $c->default_collections[] = array( 'type' => 'calendar', 'name' => $c->home_calendar_name );
 90:     if( !empty($c->home_addressbook_name) )
 91:       $c->default_collections[] = array( 'type' => 'addressbook', 'name' => $c->home_addressbook_name );
 92:   }
 93: 
 94:   if ( !is_array($c->default_collections) || !count($c->default_collections) ) return true;
 95: 
 96:   $principal = new Principal('username',$username);
 97: 
 98:   $user_fullname = $principal->fullname;  // user fullname
 99:   $user_rfullname = implode(' ', array_reverse(explode(' ', $principal->fullname)));  // user fullname in reverse order
100: 
101:   $sql = 'INSERT INTO collection (user_no, parent_container, dav_name, dav_etag, dav_displayname, is_calendar, is_addressbook, default_privileges, created, modified, resourcetypes) ';
102:   $sql .= 'VALUES( :user_no, :parent_container, :collection_path, :dav_etag, :displayname, :is_calendar, :is_addressbook, :privileges::BIT(24), current_timestamp, current_timestamp, :resourcetypes );';
103: 
104:   foreach( $c->default_collections as $v ) {
105:     if ( $v['type'] == 'calendar' || $v['type']=='addressbook' ) {
106:       if ( !empty($v['name']) ) {
107:         $qry = new AwlQuery( 'SELECT 1 FROM collection WHERE dav_name = :dav_name', array( ':dav_name' => $principal->dav_name().$v['name'].'/') );
108:         if ( !$qry->Exec() ) {
109:           $c->messages[] = i18n('There was an error reading from the database.');
110:           return false;
111:         }
112:         if ( $qry->rows() > 0 ) {
113:           $c->messages[] = i18n('Home '.( $v['type']=='calendar' ? 'calendar' : 'addressbook' ).' already exists.');
114:           return true;
115:         }
116:         else {
117:           $params[':user_no'] = $principal->user_no();
118:           $params[':parent_container'] = $principal->dav_name();
119:           $params[':dav_etag'] = '-1';
120:           $params[':collection_path'] = $principal->dav_name().$v['name'].'/';
121:           $params[':displayname'] = ( !isset($v['displayname']) || empty($v['displayname']) ? $user_fullname.( $v['type']=='calendar' ? ' calendar' : ' addressbook' ) : str_replace(array('%fn', '%rfn'), array($user_fullname, $user_rfullname), $v['displayname']) );
122:           $params[':resourcetypes'] = ( $v['type']=='calendar' ? '<DAV::collection/><urn:ietf:params:xml:ns:caldav:calendar/>' : '<DAV::collection/><urn:ietf:params:xml:ns:carddav:addressbook/>' );
123:           $params[':is_calendar'] = ( $v['type']=='calendar' ? true : false );
124:           $params[':is_addressbook'] = ( $v['type']=='addressbook' ? true : false );
125:           $params[':privileges'] = ( !isset($v['privileges']) || $v['privileges']===null ? null : privilege_to_bits($v['privileges']) );
126: 
127:           $qry = new AwlQuery( $sql, $params );
128:           if ( $qry->Exec() ) {
129:             $c->messages[] = i18n('Home '.( $v['type']=='calendar' ? 'calendar' : 'addressbook' ).' added.');
130:             dbg_error_log("User",":Write: Created user's home ".( $v['type']=='calendar' ? 'calendar' : 'addressbook' )." at '%s'", $params[':collection_path'] );
131: 
132:             // create value for urn:ietf:params:xml:ns:caldav:supported-calendar-component-set property
133:             if($v['type'] == 'calendar' && isset($v['calendar_components']) && $v['calendar_components'] != null && is_array($v['calendar_components']) && count($v['calendar_components'])) {
134:                 // convert the array to uppercase and allow only real calendar compontents
135:                 $components_clean=array_intersect(array_map("strtoupper", $v['calendar_components']), array('VEVENT', 'VTODO', 'VJOURNAL', 'VTIMEZONE', 'VFREEBUSY', 'VPOLL', 'VAVAILABILITY'));
136: 
137:                 // convert the $components_clean array to XML string
138:                 $result_xml='';
139:                 foreach($components_clean as $curr)
140:                     $result_xml.=sprintf('<comp name="%s" xmlns="urn:ietf:params:xml:ns:caldav"/>', $curr);
141: 
142:                 // handle the components XML string as user defined property (see below)
143:                 if($result_xml!='')
144:                     $v['default_properties']['urn:ietf:params:xml:ns:caldav:supported-calendar-component-set']=$result_xml;
145:             }
146: 
147:             // store all user defined properties (note: it also handles 'calendar_components' - see above)
148:             if(isset($v['default_properties']) && $v['default_properties'] != null && is_array($v['default_properties']) && count($v['default_properties'])) {
149:               $sql2='INSERT INTO property (dav_name, property_name, property_value, changed_on, changed_by) ';
150:               $sql2.='VALUES (:collection_path, :property_name, :property_value, current_timestamp, :user_no);';
151:               $params2[':user_no'] = $principal->user_no();
152:               $params2[':collection_path'] = $principal->dav_name().$v['name'].'/';
153: 
154:               foreach( $v['default_properties'] AS $key => $val ) {
155:                 $params2[':property_name'] = $key;
156:                 $params2[':property_value'] = $val;
157: 
158:                 $qry2 = new AwlQuery( $sql2, $params2 );
159:                 if ( $qry2->Exec() ) {
160:                   dbg_error_log("User",":Write: Created property '%s' for ".( $v['type']=='calendar' ? 'calendar' : 'addressbook' )." at '%s'", $params2[':property_name'], $params2[':collection_path'] );
161:                 }
162:                 else {
163:                   $c->messages[] = i18n("There was an error writing to the database.");
164:                   return false;
165:                 }
166:               }
167:             }
168:           }
169:           else {
170:             $c->messages[] = i18n("There was an error writing to the database.");
171:             return false;
172:           }
173:         }
174:       }
175:     }
176:   }
177:   return true;
178: }
179: 
180: /**
181:  * @deprecated
182:  * @param string $username
183:  */
184: function CreateHomeCalendar($username) {
185:   auth_functions_deprecated('CreateHomeCalendar','renamed to CreateHomeCollections');
186:   return CreateHomeCollections($username);
187: }
188: 
189: /**
190: * Create default relationships.
191: * @param string $username The username of the user we are creating relationships for.
192: */
193: function CreateDefaultRelationships( $username ) {
194:   global $c;
195:   if(! isset($c->default_relationships) || count($c->default_relationships) == 0) return true;
196: 
197:   $changes = false;
198:   $principal = new Principal('username', $username, true);
199:   foreach($c->default_relationships as $group => $relationships)
200:   {
201:     $sql = 'INSERT INTO grants (by_principal, to_principal, privileges) VALUES(:by_principal, :to_principal, :privileges::INT::BIT(24))';
202:     $params = array(
203:       ':by_principal' => $principal->principal_id,
204:       ':to_principal' => $group,
205:       ':privileges' => privilege_to_bits($relationships)
206:     );
207:     $qry = new AwlQuery($sql, $params);
208: 
209:     if ( $qry->Exec() ) {
210:       $changes = true;
211:       dbg_error_log("User",":Write: Created user's default relationship by:'%s', to:'%s', privileges:'%s'",$params[':by_principal'],$params[':to_principal'],$params[':privileges']);
212:     }
213:     else {
214:       $c->messages[] = i18n("There was an error writing to the database.");
215:       return false;
216:     }
217:   }
218: 
219:   if($changes)
220:     $c->messages[] = i18n("Default relationships added.");
221: 
222:   return true;
223: }
224: 
225: /**
226:  * Set a new timezone for a user's calendars
227:  * @param string $username
228:  * @param string $new_timezone
229:  */
230: function UpdateCollectionTimezones( $username, $new_timezone=null ) {
231:   if ( empty($new_timezone) ) return;
232:   $qry = new AwlQuery('UPDATE collection SET timezone=? WHERE dav_name LIKE ? AND is_calendar', '/'.$username.'/%', $new_timezone);
233:   $qry->Exec();
234: }
235: 
236: /**
237: * @deprecated
238: * @param object $usr The user details we read from the remote.
239: */
240: function UpdateUserFromExternal( &$usr ) {
241:   global $c;
242: 
243:   auth_functions_deprecated('UpdateUserFromExternal','refactor to use the "Principal" class');
244:   /**
245:   * When we're doing the create we will usually need to generate a user number
246:   */
247:   if ( !isset($usr->user_no) || intval($usr->user_no) == 0 ) {
248:     $qry = new AwlQuery( "SELECT nextval('usr_user_no_seq');" );
249:     $qry->Exec('Login',__LINE__,__FILE__);
250:     $sequence_value = $qry->Fetch(true);  // Fetch as an array
251:     $usr->user_no = $sequence_value[0];
252:   }
253: 
254:   $qry = new AwlQuery('SELECT * FROM usr WHERE user_no = :user_no', array(':user_no' => $usr->user_no) );
255:   if ( $qry->Exec('Login',__LINE__,__FILE__) && $qry->rows() == 1 ) {
256:     $type = "UPDATE";
257:     if ( $old = $qry->Fetch() ) {
258:       $changes = false;
259:       foreach( $usr AS $k => $v ) {
260:         if ( $old->{$k} != $v ) {
261:           $changes = true;
262:           dbg_error_log("Login","User '%s' field '%s' changed from '%s' to '%s'", $usr->username, $k, $old->{$k}, $v );
263:           break;
264:         }
265:       }
266:       if ( !$changes ) {
267:         dbg_error_log("Login","No changes to user record for '%s' - leaving as-is.", $usr->username );
268:         if ( isset($usr->active) && $usr->active == 'f' ) return false;
269:         return; // Normal case, if there are no changes
270:       }
271:       else {
272:         dbg_error_log("Login","Changes to user record for '%s' - updating.", $usr->username );
273:       }
274:     }
275:   }
276:   else
277:     $type = "INSERT";
278: 
279:   $params = array();
280:   if ( $type != 'INSERT' ) $params[':user_no'] = $usr->user_no;
281:   $qry = new AwlQuery( sql_from_object( $usr, $type, 'usr', 'WHERE user_no= :user_no' ), $params );
282:   $qry->Exec('Login',__LINE__,__FILE__);
283: 
284:   /**
285:   * We disallow login by inactive users _after_ we have updated the local copy
286:   */
287:   if ( isset($usr->active) && ($usr->active === 'f' || $usr->active === false) ) return false;
288: 
289:   if ( $type == 'INSERT' ) {
290:     $qry = new AwlQuery( 'INSERT INTO principal( type_id, user_no, displayname, default_privileges) SELECT 1, user_no, fullname, :privs::INT::BIT(24) FROM usr WHERE username=(text(:username))',
291:                           array( ':privs' => privilege_to_bits($c->default_privileges), ':username' => $usr->username) );
292:     $qry->Exec('Login',__LINE__,__FILE__);
293:     CreateHomeCalendar($usr->username);
294:     CreateDefaultRelationships($usr->username);
295:   }
296:   else if ( $usr->fullname != $old->{'fullname'} ) {
297:     // Also update the displayname if the fullname has been updated.
298:     $qry->QDo( 'UPDATE principal SET displayname=:new_display WHERE user_no=:user_no',
299:                     array(':new_display' => $usr->fullname, ':user_no' => $usr->user_no)
300:              );
301:   }
302: }
303: 
304: 
305: /**
306: * Authenticate against a different PostgreSQL database which contains a usr table in
307: * the AWL format.
308: *
309: * Use this as in the following example config snippet:
310: *
311: * require_once('auth-functions.php');
312: *  $c->authenticate_hook = array(
313: *      'call'   => 'AuthExternalAwl',
314: *      'config' => array(
315: *           // A PgSQL database connection string for the database containing user records
316: *          'connection[]' => 'dbname=wrms host=otherhost port=5433 user=general',
317: *           // Which columns should be fetched from the database
318: *          'columns'    => "user_no, active, email_ok, joined, last_update AS updated, last_used, username, password, fullname, email",
319: *           // a WHERE clause to limit the records returned.
320: *          'where'    => "active AND org_code=7"
321: *      )
322: *  );
323: *
324: */
325: function AuthExternalAWL( $username, $password ) {
326:   global $c;
327: 
328:   $persistent = isset($c->authenticate_hook['config']['use_persistent']) && $c->authenticate_hook['config']['use_persistent'];
329: 
330:   if ( isset($c->authenticate_hook['config']['columns']) )
331:     $cols = $c->authenticate_hook['config']['columns'];
332:   else
333:     $cols = '*';
334: 
335:   if ( isset($c->authenticate_hook['config']['where']) )
336:     $andwhere = ' AND '.$c->authenticate_hook['config']['where'];
337:   else
338:     $andwhere = '';
339: 
340:   $qry = new AwlQuery('SELECT '.$cols.' FROM usr WHERE lower(username) = :username '. $andwhere, array( ':username' => strtolower($username) ));
341:   $authconn = $qry->SetConnection($c->authenticate_hook['config']['connection'], ($persistent ? array(PDO::ATTR_PERSISTENT => true) : null));
342:   if ( ! $authconn ) {
343:     echo <<<EOERRMSG
344:   <html><head><title>Database Connection Failure</title></head><body>
345:   <h1>Database Error</h1>
346:   <h3>Could not connect to PostgreSQL database</h3>
347:   </body>
348:   </html>
349: EOERRMSG;
350:     @ob_flush();  exit(1);
351:   }
352: 
353:   if ( $qry->Exec('Login',__LINE__,__FILE__) && $qry->rows() == 1 ) {
354:     $usr = $qry->Fetch();
355:     if ( session_validate_password( $password, $usr->password ) ) {
356:       $principal = new Principal('username',$username);
357:       if ( $principal->Exists() ) {
358:         if ( $principal->modified <= $usr->updated )
359:           $principal->Update($usr);
360:       }
361:       else {
362:         $principal->Create($usr);
363:         CreateHomeCollections($username);
364:     CreateDefaultRelationships($username);
365:       }
366: 
367:       /**
368:       * We disallow login by inactive users _after_ we have updated the local copy
369:       */
370:       if ( isset($usr->active) && $usr->active == 'f' ) return false;
371: 
372:       return $principal;
373:     }
374:   }
375: 
376:   return false;
377: 
378: }
379: