sbuild::chroot Class Reference

Common chroot data. More...

#include <sbuild-chroot.h>

Inheritance diagram for sbuild::chroot:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot:

Collaboration graph
[legend]
List of all members.

Public Types

enum  setup_type {
  SETUP_START, SETUP_RECOVER, SETUP_STOP, EXEC_START,
  EXEC_STOP
}
 Type of setup to perform. More...
enum  session_flags { SESSION_CREATE = 1 << 0 }
 Chroot session properties. More...
enum  error_code {
  CHROOT_CREATE, CHROOT_DEVICE, CHROOT_TYPE, DEVICE_ABS,
  DEVICE_LOCK, DEVICE_NOTBLOCK, DEVICE_STAT, DEVICE_UNLOCK,
  FILE_ABS, FILE_LOCK, FILE_NOTREG, FILE_OWNER,
  FILE_PERMS, FILE_STAT, FILE_UNLOCK, LOCATION_ABS,
  SESSION_UNLINK, SESSION_WRITE
}
 Error codes. More...
typedef custom_error< error_codeerror
 Exception type.
typedef std::tr1::shared_ptr<
chroot
ptr
 A shared_ptr to a chroot object.

Public Member Functions

virtual ~chroot ()
 The destructor.
virtual ptr clone () const=0
 Copy the chroot.
std::string const & get_name () const
 Get the name of the chroot.
void set_name (std::string const &name)
 Set the name of the chroot.
std::string const & get_description () const
 Get the description of the chroot.
void set_description (std::string const &description)
 Set the description of the chroot.
virtual std::string const & get_mount_location () const
 Get the mount location of the chroot.
void set_mount_location (std::string const &location)
 Set the mount location of the chroot.
virtual std::string const & get_location () const
 Get the location of the chroot.
virtual std::string get_path () const
 Get the path to the chroot.
virtual std::string const & get_mount_device () const
 Get the mount device of the chroot.
void set_mount_device (std::string const &device)
 Set the mount device of the chroot.
unsigned int get_priority () const
 Get the priority of the chroot.
void set_priority (unsigned int priority)
 Set the priority of a chroot.
string_list const & get_users () const
 Get the users allowed to access the chroot.
void set_users (string_list const &users)
 Set the users allowed to access the chroot.
string_list const & get_groups () const
 Get the groups allowed to access the chroot.
void set_groups (string_list const &groups)
 Set the users allowed to access the chroot.
string_list const & get_root_users () const
 Get the users allowed to access the chroot as root.
void set_root_users (string_list const &users)
 Set the users allowed to access the chroot as root.
string_list const & get_root_groups () const
 Get the groups allowed to access the chroot as root.
void set_root_groups (string_list const &groups)
 Set the groups allowed to access the chroot as root.
string_list const & get_aliases () const
 Get the aliases of the chroot.
void set_aliases (string_list const &aliases)
 Set the aliases of the chroot.
regex const & get_environment_filter () const
 Get the environment filter of the chroot.
void set_environment_filter (regex const &environment_filter)
 Get the environment filter of the chroot.
bool get_active () const
 Get the activity status of the chroot.
void set_active (bool active)
 Set the activity status of the chroot.
bool get_original () const
 Get the originality of the chroot.
void set_original (bool original)
 Set the originality of the chroot.
bool get_run_setup_scripts () const
 Check if chroot setup scripts will be run.
void set_run_setup_scripts (bool run_setup_scripts)
 Set whether chroot setup scripts will be run.
bool get_run_exec_scripts () const
 Check if chroot exec scripts will be run.
void set_run_exec_scripts (bool run_exec_scripts)
 Set whether chroot exec scripts will be run.
std::string const & get_script_config () const
 Get the script configuration file for the chroot.
void set_script_config (std::string const &script_config)
 Set the script configuration file for the chroot.
string_list const & get_command_prefix () const
 Get the command_prefix for the chroot.
void set_command_prefix (string_list const &command_prefix)
 Set the command_prefix for the chroot.
personality const & get_persona () const
 Get the process execution domain for the chroot.
void set_persona (personality const &persona)
 Set the process execution domain for the chroot.
virtual std::string const & get_chroot_type () const=0
 Get the type of the chroot.
virtual void setup_env (environment &env)
 Set environment.
void lock (setup_type type)
 Lock a chroot during setup.
void unlock (setup_type type, int status)
 Unlock a chroot during setup.
virtual session_flags get_session_flags () const=0
 Get the session flags of the chroot.

Static Public Member Functions

static ptr create (std::string const &type)
 Create a chroot.

Protected Member Functions

 chroot ()
 The constructor.
virtual void set_location (std::string const &location)
 Set the location of the chroot.
virtual void setup_session_info (bool start)
 Set up persistent session information.
virtual void setup_lock (setup_type type, bool lock, int status)=0
 Unlock a chroot during setup.
virtual void get_details (format_detail &detail) const
 Get detailed information about the chroot for output.
void print_details (std::ostream &stream) const
 Print detailed information about the chroot to a stream.
virtual void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
virtual void set_keyfile (keyfile const &keyfile)
 Set the chroot properties from a keyfile.

Private Attributes

std::string name
 Chroot name.
std::string description
 Chroot description.
unsigned int priority
 Chroot prioroty.
string_list users
 Users allowed to access the chroot.
string_list groups
 Groups allowed to access the chroot.
string_list root_users
 Users allowed to access the chroot as root.
string_list root_groups
 Groups allowed to access the chroot as root.
string_list aliases
 Alternative names for the chroot.
regex environment_filter
 Environment filter regex.
std::string mount_location
 Location to mount chroot in the filesystem (if any).
std::string location
 Location inside the mount location root.
std::string mount_device
 Block device to mount (if any).
bool active
 Chroot activity status.
bool original
 Was the chroot automatically generated?
bool run_setup_scripts
 Run chroot setup scripts?
bool run_exec_scripts
 Run chroot exec scripts?
std::string script_config
 Configuration of the setup and exec scripts.
string_list command_prefix
 Command prefix.
personality persona
 Process execution domain (Linux only).

Friends

std::ostream & operator<< (std::ostream &stream, ptr const &rhs)
 Print detailed information about the chroot to a stream.
keyfile const & operator>> (keyfile const &keyfile, ptr &rhs)
 Chroot initialisation from a keyfile.
keyfileoperator<< (keyfile &keyfile, ptr const &rhs)
 Chroot serialisation to a keyfile.

Detailed Description

Common chroot data.

This class contains all of the metadata associated with a single chroot, for all chroot types. This is the in-core representation of a chroot definition in the configuration file, and may be initialised directly from an open keyfile.


Member Typedef Documentation

typedef custom_error<error_code> sbuild::chroot::error

Exception type.

typedef std::tr1::shared_ptr<chroot> sbuild::chroot::ptr

A shared_ptr to a chroot object.


Member Enumeration Documentation

enum sbuild::chroot::setup_type

Type of setup to perform.

Enumerator:
SETUP_START  Activate a chroot.
SETUP_RECOVER  Reactivate a chroot.
SETUP_STOP  Deactivate a chroot.
EXEC_START  Start executing a command in an active chroot.
EXEC_STOP  End executing a command in an active chroot.

enum sbuild::chroot::session_flags

Chroot session properties.

Enumerator:
SESSION_CREATE  The chroot supports session creation.

enum sbuild::chroot::error_code

Error codes.

Enumerator:
CHROOT_CREATE  Chroot creation failed.
CHROOT_DEVICE  Chroot device name not set.
CHROOT_TYPE  Unknown chroot type.
DEVICE_ABS  Device must have an absolute path.
DEVICE_LOCK  Failed to lock device.
DEVICE_NOTBLOCK  File is not a block device.
DEVICE_STAT  Failed to stat device.
DEVICE_UNLOCK  Failed to unlock device.
FILE_ABS  File must have an absolute path.
FILE_LOCK  Failed to acquire lock.
FILE_NOTREG  File is not a regular file.
FILE_OWNER  File is not owned by user root.
FILE_PERMS  File has write permissions for others.
FILE_STAT  Failed to stat file.
FILE_UNLOCK  Failed to discard lock.
LOCATION_ABS  Location must have an absolute path.
SESSION_UNLINK  Failed to unlink session file.
SESSION_WRITE  Failed to write session file.


Constructor & Destructor Documentation

sbuild::chroot::chroot (  )  [protected]

The constructor.

sbuild::chroot::~chroot (  )  [virtual]

The destructor.


Member Function Documentation

sbuild::chroot::ptr sbuild::chroot::create ( std::string const &  type  )  [static]

Create a chroot.

This is a factory function.

Parameters:
type the type of chroot to create.
Returns:
a shared_ptr to the new chroot.

virtual ptr sbuild::chroot::clone (  )  const [pure virtual]

Copy the chroot.

This is a virtual copy constructor.

Returns:
a shared_ptr to the new copy of the chroot.

Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.

std::string const & sbuild::chroot::get_name (  )  const

Get the name of the chroot.

Returns:
the name.

void sbuild::chroot::set_name ( std::string const &  name  ) 

Set the name of the chroot.

Parameters:
name the name.

std::string const & sbuild::chroot::get_description (  )  const

Get the description of the chroot.

Returns:
the description.

void sbuild::chroot::set_description ( std::string const &  description  ) 

Set the description of the chroot.

Parameters:
description the description.

std::string const & sbuild::chroot::get_mount_location (  )  const [virtual]

Get the mount location of the chroot.

Returns:
the mount location.

void sbuild::chroot::set_mount_location ( std::string const &  location  ) 

Set the mount location of the chroot.

Parameters:
location the mount location.

std::string const & sbuild::chroot::get_location (  )  const [virtual]

Get the location of the chroot.

This is the path to the root of the chroot, and is typically the same as the mount location, but is overridden by the chroot type if required.

Returns:
the mount location.

Reimplemented in sbuild::chroot_block_device, and sbuild::chroot_directory.

void sbuild::chroot::set_location ( std::string const &  location  )  [protected, virtual]

Set the location of the chroot.

This is the path to the root of the chroot, and is typically the same as the mount location, but is overridden by the chroot type if required.

Parameters:
location the mount location.

Reimplemented in sbuild::chroot_block_device, and sbuild::chroot_directory.

std::string sbuild::chroot::get_path (  )  const [virtual]

Get the path to the chroot.

This is the absolute path to the root of the chroot, and is typically the same as the mount location and location concatenated together, but is overridden by the chroot type if required.

Returns:
the path.

Reimplemented in sbuild::chroot_directory.

std::string const & sbuild::chroot::get_mount_device (  )  const [virtual]

Get the mount device of the chroot.

Returns:
the device.

Reimplemented in sbuild::chroot_block_device, and sbuild::chroot_lvm_snapshot.

void sbuild::chroot::set_mount_device ( std::string const &  device  ) 

Set the mount device of the chroot.

Parameters:
device the device.

unsigned int sbuild::chroot::get_priority (  )  const

Get the priority of the chroot.

This is a number indicating whether than a ditribution is older than another.

Returns:
the priority.

void sbuild::chroot::set_priority ( unsigned int  priority  ) 

Set the priority of a chroot.

This is a number indicating whether a distribution is older than another. For example, "oldstable" and "oldstable-security" might be 0, while "stable" and "stable-security" 1, "testing" 2 and "unstable" 3. The values are not important, but the difference between them is.

Parameters:
priority the priority.

string_list const & sbuild::chroot::get_users (  )  const

Get the users allowed to access the chroot.

Returns:
a list of users.

void sbuild::chroot::set_users ( string_list const &  users  ) 

Set the users allowed to access the chroot.

Parameters:
users a list of users.

string_list const & sbuild::chroot::get_groups (  )  const

Get the groups allowed to access the chroot.

Returns:
a list of groups.

void sbuild::chroot::set_groups ( string_list const &  groups  ) 

Set the users allowed to access the chroot.

Parameters:
groups a list of groups.

string_list const & sbuild::chroot::get_root_users (  )  const

Get the users allowed to access the chroot as root.

Mmebers of these users can switch to root without authenticating themselves.

Returns:
a list of users.

void sbuild::chroot::set_root_users ( string_list const &  users  ) 

Set the users allowed to access the chroot as root.

Mmebers of these users can switch to root without authenticating themselves.

Parameters:
users a list of users.

string_list const & sbuild::chroot::get_root_groups (  )  const

Get the groups allowed to access the chroot as root.

Mmebers of these groups can switch to root without authenticating themselves.

Returns:
a list of groups.

void sbuild::chroot::set_root_groups ( string_list const &  groups  ) 

Set the groups allowed to access the chroot as root.

Mmebers of these groups can switch to root without authenticating themselves.

Parameters:
groups a list of groups.

string_list const & sbuild::chroot::get_aliases (  )  const

Get the aliases of the chroot.

These are alternative names for the chroot.

Returns:
a list of names.

void sbuild::chroot::set_aliases ( string_list const &  aliases  ) 

Set the aliases of the chroot.

These are alternative names for the chroot.

Parameters:
aliases a list of names.

regex const & sbuild::chroot::get_environment_filter (  )  const

Get the environment filter of the chroot.

This is a POSIX extended regular expression used to remove insecure environment variables from the chroot environment.

Returns:
the filter

void sbuild::chroot::set_environment_filter ( regex const &  environment_filter  ) 

Get the environment filter of the chroot.

This is a POSIX extended regular expression used to remove insecure environment variables from the chroot environment.

Parameters:
environment_filter the filter.

bool sbuild::chroot::get_active (  )  const

Get the activity status of the chroot.

Returns:
true if active, false if inactive

void sbuild::chroot::set_active ( bool  active  ) 

Set the activity status of the chroot.

Parameters:
active true if active, false if inactive

bool sbuild::chroot::get_original (  )  const

Get the originality of the chroot.

Returns:
true if original, false if generated.

void sbuild::chroot::set_original ( bool  original  ) 

Set the originality of the chroot.

Parameters:
original true if original, false if geneated.

bool sbuild::chroot::get_run_setup_scripts (  )  const

Check if chroot setup scripts will be run.

Returns:
true if setup scripts will be run, otherwise false.

void sbuild::chroot::set_run_setup_scripts ( bool  run_setup_scripts  ) 

Set whether chroot setup scripts will be run.

Parameters:
run_setup_scripts true if setup scripts will be run, otherwise false.

bool sbuild::chroot::get_run_exec_scripts (  )  const

Check if chroot exec scripts will be run.

Returns:
true if exec scripts will be run, otherwise false.

void sbuild::chroot::set_run_exec_scripts ( bool  run_exec_scripts  ) 

Set whether chroot exec scripts will be run.

Parameters:
run_exec_scripts true if exec scripts will be run, otherwise false.

std::string const & sbuild::chroot::get_script_config (  )  const

Get the script configuration file for the chroot.

This is a filename, either relative to the configured pkgsysconfdir or an absolute path.

Returns:
the configuration file name.

void sbuild::chroot::set_script_config ( std::string const &  script_config  ) 

Set the script configuration file for the chroot.

This is a filename, either relative to the configured pkgsysconfdir or an absolute path.

Parameters:
script_config the script configuration file.

string_list const & sbuild::chroot::get_command_prefix (  )  const

Get the command_prefix for the chroot.

This is a command to prefix to any command run in the chroot.

Returns:
the command prefix.

void sbuild::chroot::set_command_prefix ( string_list const &  command_prefix  ) 

Set the command_prefix for the chroot.

This is a command to prefix to any command run in the chroot.

Parameters:
command_prefix the command prefix.

personality const & sbuild::chroot::get_persona (  )  const

Get the process execution domain for the chroot.

Returns:
the personality.

void sbuild::chroot::set_persona ( personality const &  persona  ) 

Set the process execution domain for the chroot.

Parameters:
persona the personality.

virtual std::string const& sbuild::chroot::get_chroot_type (  )  const [pure virtual]

Get the type of the chroot.

Returns:
the chroot type.

Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.

void sbuild::chroot::setup_env ( environment env  )  [virtual]

Set environment.

Set the environment that the setup scripts will see during execution.

Parameters:
env the environment to set.

Reimplemented in sbuild::chroot_block_device, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_source.

void sbuild::chroot::lock ( setup_type  type  ) 

Lock a chroot during setup.

The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.

An error will be thrown on failure.

Parameters:
type the type of setup being performed

void sbuild::chroot::unlock ( setup_type  type,
int  status 
)

Unlock a chroot during setup.

The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.

An error will be thrown on failure.

Parameters:
type the type of setup being performed
status the exit status of the setup commands (0 for success, nonzero for failure).

void sbuild::chroot::setup_session_info ( bool  start  )  [protected, virtual]

Set up persistent session information.

Parameters:
start true if startion, or false if ending a session.

virtual void sbuild::chroot::setup_lock ( setup_type  type,
bool  lock,
int  status 
) [protected, pure virtual]

Unlock a chroot during setup.

The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.

An error will be thrown on failure.

Parameters:
type the type of setup being performed
lock true to lock, false to unlock
status the exit status of the setup commands (0 for success, nonzero for failure).

Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

virtual session_flags sbuild::chroot::get_session_flags (  )  const [pure virtual]

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Returns:
the session flags.

Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

void sbuild::chroot::get_details ( format_detail detail  )  const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
detail the details to output to.

Reimplemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_source.

void sbuild::chroot::print_details ( std::ostream &  stream  )  const [protected]

Print detailed information about the chroot to a stream.

The information is printed in plain text with one line per property.

Parameters:
stream the stream to output to.

void sbuild::chroot::get_keyfile ( keyfile keyfile  )  const [protected, virtual]

Copy the chroot properties into a keyfile.

The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.

Parameters:
keyfile the keyfile to use.

Reimplemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_source.

void sbuild::chroot::set_keyfile ( keyfile const &  keyfile  )  [protected, virtual]

Set the chroot properties from a keyfile.

The chroot name must have previously been set, so that the correct keyfile group may be determined.

Parameters:
keyfile the keyfile to get the properties from.

Reimplemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_lvm_snapshot, and sbuild::chroot_source.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  stream,
ptr const &  rhs 
) [friend]

Print detailed information about the chroot to a stream.

The information is printed in plain text with one line per property.

Parameters:
stream the stream to output to.
rhs the chroot to output.
Returns:
the stream.

keyfile const& operator>> ( keyfile const &  keyfile,
ptr rhs 
) [friend]

Chroot initialisation from a keyfile.

keyfile& operator<< ( keyfile keyfile,
ptr const &  rhs 
) [friend]

Chroot serialisation to a keyfile.


Member Data Documentation

std::string sbuild::chroot::name [private]

Chroot name.

std::string sbuild::chroot::description [private]

Chroot description.

unsigned int sbuild::chroot::priority [private]

Chroot prioroty.

string_list sbuild::chroot::users [private]

Users allowed to access the chroot.

string_list sbuild::chroot::groups [private]

Groups allowed to access the chroot.

string_list sbuild::chroot::root_users [private]

Users allowed to access the chroot as root.

string_list sbuild::chroot::root_groups [private]

Groups allowed to access the chroot as root.

string_list sbuild::chroot::aliases [private]

Alternative names for the chroot.

regex sbuild::chroot::environment_filter [private]

Environment filter regex.

std::string sbuild::chroot::mount_location [private]

Location to mount chroot in the filesystem (if any).

std::string sbuild::chroot::location [private]

Location inside the mount location root.

std::string sbuild::chroot::mount_device [private]

Block device to mount (if any).

bool sbuild::chroot::active [private]

Chroot activity status.

bool sbuild::chroot::original [private]

Was the chroot automatically generated?

bool sbuild::chroot::run_setup_scripts [private]

Run chroot setup scripts?

bool sbuild::chroot::run_exec_scripts [private]

Run chroot exec scripts?

std::string sbuild::chroot::script_config [private]

Configuration of the setup and exec scripts.

string_list sbuild::chroot::command_prefix [private]

Command prefix.

personality sbuild::chroot::persona [private]

Process execution domain (Linux only).


The documentation for this class was generated from the following files:
Generated on Sun Jul 8 21:23:50 2007 for sbuild by  doxygen 1.5.2