2009-07-09 18:34:34 +04:00
/* -------------------------------------------------------------------------- */
2011-02-25 16:34:44 +03:00
/* Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org) */
2009-07-09 18:34:34 +04:00
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); you may */
/* not use this file except in compliance with the License. You may obtain */
/* a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* -------------------------------------------------------------------------- */
# ifndef USER_H_
# define USER_H_
# include "PoolSQL.h"
using namespace std ;
/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */
/**
2010-04-05 02:07:31 +04:00
* The User class .
2009-07-09 18:34:34 +04:00
*/
2011-07-07 21:01:04 +04:00
class User : public PoolObjectSQL
2009-07-09 18:34:34 +04:00
{
public :
2010-04-05 02:07:31 +04:00
2011-09-09 20:31:46 +04:00
/**
* Characters that can not be in a password
*/
2011-09-13 19:50:45 +04:00
static const string INVALID_CHARS ;
2011-09-09 20:31:46 +04:00
2010-04-05 02:07:31 +04:00
/**
* Function to print the User object into a string in XML format
* @ param xml the resulting XML string
* @ return a reference to the generated string
*/
string & to_xml ( string & xml ) const ;
2009-07-09 18:34:34 +04:00
/**
* Check if the user is enabled
* @ return true if the user is enabled
*/
bool isEnabled ( ) const
{
return enabled ;
}
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
/**
* Returns user password
* @ return username User ' s hostname
*/
2010-04-05 02:07:31 +04:00
const string & get_password ( ) const
2009-07-09 18:34:34 +04:00
{
2010-04-05 02:07:31 +04:00
return password ;
} ;
/**
2009-07-09 18:34:34 +04:00
* Enables the current user
2010-04-05 02:07:31 +04:00
*/
2009-07-09 18:34:34 +04:00
void enable ( )
{
enabled = true ;
} ;
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
/**
* Disables the current user
2010-04-05 02:07:31 +04:00
*/
2009-07-09 18:34:34 +04:00
void disable ( )
{
enabled = false ;
} ;
2010-04-05 02:07:31 +04:00
/**
2011-09-13 19:50:45 +04:00
* Checks if a name or password is valid , i . e . it is not empty and does not
* contain invalid characters .
* @ param str Name or password to be checked
* @ param error_str Returns the error reason , if any
* @ return true if the string is valid
2011-09-09 20:31:46 +04:00
*/
2011-09-13 19:50:45 +04:00
static bool is_valid ( const string & str , string & error_str )
2011-09-09 20:31:46 +04:00
{
2011-09-13 19:50:45 +04:00
if ( str . empty ( ) )
{
error_str = " cannot be empty " ;
return false ;
}
size_t pos = str . find_first_of ( INVALID_CHARS ) ;
if ( pos ! = string : : npos )
{
ostringstream oss ;
oss < < " character ' " < < str . at ( pos ) < < " ' is not allowed " ;
error_str = oss . str ( ) ;
return false ;
}
return true ;
2011-09-09 20:31:46 +04:00
}
/**
* Sets user password . It checks that the new password does not contain
* forbidden chars .
* @ param _password the new pass
2011-09-13 19:50:45 +04:00
* @ param error_str Returns the error reason , if any
2011-09-09 20:31:46 +04:00
* @ returns - 1 if the password is not valid
2009-07-09 18:34:34 +04:00
*/
2011-09-13 19:50:45 +04:00
int set_password ( const string & passwd , string & error_str )
2009-07-09 18:34:34 +04:00
{
2011-09-09 20:31:46 +04:00
int rc = 0 ;
2011-09-13 19:50:45 +04:00
if ( is_valid ( passwd , error_str ) )
2011-09-09 20:31:46 +04:00
{
password = passwd ;
}
else
{
2011-09-13 19:50:45 +04:00
error_str = string ( " Invalid password: " ) . append ( error_str ) ;
2011-09-09 20:31:46 +04:00
rc = - 1 ;
}
return rc ;
2010-04-05 02:07:31 +04:00
} ;
2009-07-09 18:34:34 +04:00
/**
* Splits an authentication token ( < usr > : < pass > )
* @ param secret , the authentication token
* @ param username
* @ param password
2010-04-05 02:07:31 +04:00
* @ return 0 on success
2009-07-09 18:34:34 +04:00
* */
static int split_secret ( const string secret , string & user , string & pass ) ;
private :
// -------------------------------------------------------------------------
// Friends
// -------------------------------------------------------------------------
2010-04-05 02:07:31 +04:00
friend class UserPool ;
2009-07-09 18:34:34 +04:00
// -------------------------------------------------------------------------
// User Attributes
// -------------------------------------------------------------------------
/**
* User ' s password
*/
string password ;
/**
* Flag marking user enabled / disabled
*/
bool enabled ;
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
// *************************************************************************
// DataBase implementation (Private)
// *************************************************************************
2010-04-26 20:14:00 +04:00
/**
* Execute an INSERT or REPLACE Sql query .
* @ param db The SQL DB
* @ param replace Execute an INSERT or a REPLACE
* @ return 0 one success
*/
int insert_replace ( SqlDB * db , bool replace ) ;
2009-07-09 18:34:34 +04:00
/**
* Bootstraps the database table ( s ) associated to the User
*/
2010-04-05 02:07:31 +04:00
static void bootstrap ( SqlDB * db )
{
ostringstream oss_user ( User : : db_bootstrap ) ;
db - > exec ( oss_user ) ;
2009-07-09 18:34:34 +04:00
} ;
2011-03-04 19:04:28 +03:00
/**
* Rebuilds the object from an xml formatted string
* @ param xml_str The xml - formatted string
*
* @ return 0 on success , - 1 otherwise
*/
int from_xml ( const string & xml_str ) ;
2011-06-03 18:58:42 +04:00
2009-07-09 18:34:34 +04:00
protected :
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
// *************************************************************************
// Constructor
// *************************************************************************
2011-06-30 13:31:00 +04:00
User ( int id ,
int _gid ,
const string & _uname ,
const string & _gname ,
const string & _password ,
bool _enabled ) :
PoolObjectSQL ( id , _uname , - 1 , _gid , " " , _gname , table ) ,
password ( _password ) ,
enabled ( _enabled ) { } ;
2009-07-09 18:34:34 +04:00
2011-05-23 00:30:36 +04:00
virtual ~ User ( ) { } ;
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
// *************************************************************************
// DataBase implementation
// *************************************************************************
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
static const char * db_names ;
static const char * db_bootstrap ;
2010-04-05 02:07:31 +04:00
2009-07-09 18:34:34 +04:00
static const char * table ;
/**
* Writes the User in the database .
* @ param db pointer to the db
* @ return 0 on success
*/
2011-03-09 14:47:49 +03:00
int insert ( SqlDB * db , string & error_str ) ;
2009-07-09 18:34:34 +04:00
/**
* Writes / updates the User data fields in the database .
* @ param db pointer to the db
* @ return 0 on success
*/
2011-03-09 14:47:49 +03:00
int update ( SqlDB * db )
{
return insert_replace ( db , true ) ;
}
2009-07-09 18:34:34 +04:00
} ;
# endif /*USER_H_*/