Common chroot data. More...
#include <sbuild-chroot.h>
Public Types | |
enum | setup_type { SETUP_START, SETUP_RECOVER, SETUP_STOP } |
Type of setup to perform. More... | |
enum | session_flags { SESSION_NOFLAGS = 0, SESSION_CREATE = 1 << 0, SESSION_CLONE = 1 << 1, SESSION_PURGE = 1 << 2 } |
Chroot session properties. More... | |
enum | error_code { CHROOT_CREATE, CHROOT_DEVICE, CHROOT_TYPE, DEVICE_ABS, DEVICE_LOCK, DEVICE_NOTBLOCK, DEVICE_UNLOCK, DIRECTORY_ABS, FACET_INVALID, FACET_PRESENT, FILE_ABS, FILE_LOCK, FILE_NOTREG, FILE_OWNER, FILE_PERMS, FILE_UNLOCK, LOCATION_ABS, SESSION_UNLINK, SESSION_WRITE } |
Error codes. More... | |
typedef custom_error< error_code > | error |
Exception type. | |
typedef std::tr1::shared_ptr < chroot > | ptr |
A shared_ptr to a chroot object. | |
typedef std::tr1::shared_ptr < const chroot > | const_ptr |
A shared_ptr to a const chroot object. | |
Public Member Functions | |
virtual | ~chroot () |
The destructor. | |
virtual ptr | clone () const =0 |
Copy the chroot. | |
virtual chroot::ptr | clone_session (std::string const &session_id, std::string const &user, bool root) const =0 |
Create a session chroot. | |
virtual chroot::ptr | clone_source () const =0 |
Create a source 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_session_id () const |
Get the session ID of the chroot. | |
void | set_session_id (std::string const &session_id) |
Set the session ID of the chroot. | |
std::string const & | get_keyfile_name () const |
Get the keyfile 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. | |
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 | get_path () const =0 |
Get the path to 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. | |
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. | |
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. | |
virtual std::string const & | get_chroot_type () const =0 |
Get the type of the chroot. | |
void | setup_env (environment &env) const |
Set environment. | |
virtual void | setup_env (chroot const &chroot, environment &env) const =0 |
Set environment. | |
void | lock (setup_type type) |
Lock a chroot during setup. | |
void | unlock (setup_type type, int status) |
Unlock a chroot during setup. | |
template<typename T > | |
std::tr1::shared_ptr< T > | get_facet () |
template<typename T > | |
const std::tr1::shared_ptr < const T > | get_facet () const |
template<typename T > | |
void | add_facet (std::tr1::shared_ptr< T > facet) |
template<typename T > | |
void | remove_facet () |
template<typename T > | |
void | remove_facet (std::tr1::shared_ptr< T > facet) |
template<typename T > | |
void | replace_facet (std::tr1::shared_ptr< T > facet) |
string_list | list_facets () const |
session_flags | get_session_flags () const |
Get the session flags of the chroot. | |
virtual chroot::session_flags | get_session_flags (chroot const &chroot) const =0 |
Get the session flags of the chroot. | |
void | get_details (format_detail &detail) const |
Get detailed information about the chroot for output. | |
virtual void | get_details (chroot const &chroot, format_detail &detail) const =0 |
Get detailed information about the chroot for output. | |
void | print_details (std::ostream &stream) const |
Print detailed information about the chroot to a stream. | |
void | get_keyfile (keyfile &keyfile) const |
Copy the chroot properties into a keyfile. | |
void | set_keyfile (keyfile const &keyfile, string_list &used_keys) |
Set the chroot properties from a keyfile. | |
Static Public Member Functions | |
static ptr | create (std::string const &type) |
Create a chroot. | |
Protected Member Functions | |
chroot () | |
The constructor. | |
chroot (const chroot &rhs) | |
The copy constructor. | |
void | set_run_setup_scripts (bool run_setup_scripts) |
Set whether chroot setup scripts will be run. | |
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_keyfile (chroot const &chroot, keyfile &keyfile) const =0 |
Copy the chroot properties into a keyfile. | |
virtual void | set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys)=0 |
Set the chroot properties from a keyfile. | |
Private Types | |
typedef std::tr1::shared_ptr < chroot_facet > | facet_ptr |
typedef std::list< facet_ptr > | facet_list |
Private Attributes | |
std::string | name |
Chroot name. | |
std::string | session_id |
Chroot session ID. | |
std::string | description |
Chroot description. | |
unsigned int | priority |
Chroot priority. | |
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). | |
bool | original |
Was the chroot automatically generated? | |
bool | run_setup_scripts |
Run chroot setup scripts? | |
std::string | script_config |
Configuration of the setup and exec scripts. | |
string_list | command_prefix |
Command prefix. | |
facet_list | facets |
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. | |
keyfile & | operator<< (keyfile &keyfile, ptr const &rhs) |
Chroot serialisation to a keyfile. |
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.
typedef std::tr1::shared_ptr<const chroot> sbuild::chroot::const_ptr |
A shared_ptr to a const chroot object.
typedef custom_error<error_code> sbuild::chroot::error |
Exception type.
Reimplemented in sbuild::chroot_block_device, and sbuild::chroot_loopback.
typedef std::list<facet_ptr> sbuild::chroot::facet_list [private] |
typedef std::tr1::shared_ptr<chroot_facet> sbuild::chroot::facet_ptr [private] |
typedef std::tr1::shared_ptr<chroot> sbuild::chroot::ptr |
A shared_ptr to a chroot object.
Error codes.
sbuild::chroot::chroot | ( | ) | [protected] |
The constructor.
References add_facet(), sbuild::chroot_facet_session_clonable::create(), and sbuild::chroot_facet_personality::create().
sbuild::chroot::chroot | ( | const chroot & | rhs | ) | [protected] |
sbuild::chroot::~chroot | ( | ) | [virtual] |
The destructor.
void sbuild::chroot::add_facet | ( | std::tr1::shared_ptr< T > | facet | ) | [inline] |
References FACET_INVALID, FACET_PRESENT, and facets.
Referenced by chroot(), sbuild::chroot_block_device::chroot_block_device(), sbuild::chroot_block_device_base::chroot_block_device_base(), sbuild::chroot_directory::chroot_directory(), sbuild::chroot_file::chroot_file(), sbuild::chroot_loopback::chroot_loopback(), sbuild::chroot_lvm_snapshot::chroot_lvm_snapshot(), replace_facet(), and sbuild::chroot_facet_union::set_union_type().
virtual ptr sbuild::chroot::clone | ( | ) | const [pure virtual] |
Copy the chroot.
This is a virtual copy constructor.
Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
virtual chroot::ptr sbuild::chroot::clone_session | ( | std::string const & | session_id, | |
std::string const & | user, | |||
bool | root | |||
) | const [pure virtual] |
Create a session chroot.
session_id | the identifier for the new session. | |
user | the user creating the session. | |
root | true if the user has root access, otherwise false. |
Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
virtual chroot::ptr sbuild::chroot::clone_source | ( | ) | const [pure virtual] |
Create a source chroot.
Implemented in sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
sbuild::chroot::ptr sbuild::chroot::create | ( | std::string const & | type | ) | [static] |
Create a chroot.
This is a factory function.
type | the type of chroot to create. |
References CHROOT_CREATE, and CHROOT_TYPE.
Referenced by sbuild::chroot_config::load_keyfile().
bool sbuild::chroot::get_active | ( | ) | const |
Get the activity status of the chroot.
The chroot is active if it has been cloned as a session.
Referenced by get_keyfile(), sbuild::chroot_lvm_snapshot::get_keyfile(), sbuild::chroot_file::get_keyfile(), sbuild::chroot_facet_mountable::get_keyfile(), get_keyfile_name(), sbuild::chroot_lvm_snapshot::get_session_flags(), sbuild::chroot_file::get_session_flags(), sbuild::chroot_facet_union::get_session_flags(), sbuild::chroot_facet_source_clonable::get_session_flags(), print_details(), set_keyfile(), sbuild::chroot_lvm_snapshot::set_keyfile(), sbuild::chroot_file::set_keyfile(), sbuild::chroot_facet_union::set_keyfile(), and sbuild::chroot_facet_mountable::set_keyfile().
string_list const & sbuild::chroot::get_aliases | ( | ) | const |
Get the aliases of the chroot.
These are alternative names for the chroot.
References aliases.
Referenced by get_details(), and get_keyfile().
virtual std::string const& sbuild::chroot::get_chroot_type | ( | ) | const [pure virtual] |
Get the type of the chroot.
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
Referenced by get_details(), get_keyfile(), and setup_env().
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.
References command_prefix.
Referenced by get_details(), and get_keyfile().
std::string const & sbuild::chroot::get_description | ( | ) | const |
Get the description of the chroot.
References description.
Referenced by get_details(), get_keyfile(), and setup_env().
void sbuild::chroot::get_details | ( | chroot const & | chroot, | |
format_detail & | detail | |||
) | const [pure virtual] |
Get detailed information about the chroot for output.
chroot | the chroot to use. | |
detail | the details to output to. |
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_block_device, sbuild::chroot_directory_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, and sbuild::chroot_lvm_snapshot.
References sbuild::_(), sbuild::format_detail::add(), get_aliases(), get_chroot_type(), get_command_prefix(), get_description(), get_environment_filter(), get_groups(), get_mount_location(), get_name(), get_path(), get_priority(), get_root_groups(), get_root_users(), get_run_setup_scripts(), get_script_config(), get_session_flags(), get_users(), SESSION_CLONE, SESSION_CREATE, and SESSION_PURGE.
void sbuild::chroot::get_details | ( | format_detail & | detail | ) | const |
Get detailed information about the chroot for output.
detail | the details to output to. |
References facets.
Referenced by print_details().
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.
References environment_filter.
Referenced by get_details(), and get_keyfile().
const std::tr1::shared_ptr< const T > sbuild::chroot::get_facet | ( | ) | const [inline] |
References facets.
std::tr1::shared_ptr< T > sbuild::chroot::get_facet | ( | ) | [inline] |
string_list const & sbuild::chroot::get_groups | ( | ) | const |
Get the groups allowed to access the chroot.
References groups.
Referenced by get_details(), and get_keyfile().
void sbuild::chroot::get_keyfile | ( | chroot const & | chroot, | |
keyfile & | keyfile | |||
) | const [protected, pure 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.
chroot | the chroot to use. | |
keyfile | the keyfile to use. |
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_block_device, sbuild::chroot_directory_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, and sbuild::chroot_lvm_snapshot.
References get_active(), get_aliases(), get_chroot_type(), get_command_prefix(), get_description(), get_environment_filter(), get_groups(), get_keyfile_name(), get_mount_location(), get_name(), get_priority(), get_root_groups(), get_root_users(), get_script_config(), get_users(), sbuild::basic_keyfile< K, P >::remove_group(), sbuild::basic_keyfile< K, P >::set_object_list_value(), and sbuild::basic_keyfile< K, P >::set_object_value().
void sbuild::chroot::get_keyfile | ( | keyfile & | keyfile | ) | const |
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.
keyfile | the keyfile to use. |
References facets.
Referenced by setup_session_info().
std::string const & sbuild::chroot::get_keyfile_name | ( | ) | const |
Get the keyfile name of the chroot.
Depending on whether the chroot is active or not, this will return the session ID or the chroot name, respectively.
References get_active(), name, and session_id.
Referenced by get_keyfile(), sbuild::chroot_lvm_snapshot::get_keyfile(), sbuild::chroot_loopback::get_keyfile(), sbuild::chroot_file::get_keyfile(), sbuild::chroot_facet_union::get_keyfile(), sbuild::chroot_facet_source_clonable::get_keyfile(), sbuild::chroot_facet_personality::get_keyfile(), sbuild::chroot_facet_mountable::get_keyfile(), sbuild::chroot_directory_base::get_keyfile(), sbuild::chroot_block_device_base::get_keyfile(), set_keyfile(), sbuild::chroot_lvm_snapshot::set_keyfile(), sbuild::chroot_loopback::set_keyfile(), sbuild::chroot_file::set_keyfile(), sbuild::chroot_facet_union::set_keyfile(), sbuild::chroot_facet_source_clonable::set_keyfile(), sbuild::chroot_facet_session::set_keyfile(), sbuild::chroot_facet_personality::set_keyfile(), sbuild::chroot_facet_mountable::set_keyfile(), sbuild::chroot_directory_base::set_keyfile(), and sbuild::chroot_block_device_base::set_keyfile().
std::string const & sbuild::chroot::get_mount_location | ( | ) | const |
Get the mount location of the chroot.
References mount_location.
Referenced by get_details(), get_keyfile(), sbuild::chroot_loopback::get_path(), sbuild::chroot_file::get_path(), sbuild::chroot_directory::get_path(), sbuild::chroot_block_device_base::get_path(), and setup_env().
std::string const & sbuild::chroot::get_name | ( | ) | const |
Get the name of the chroot.
References name.
Referenced by get_details(), get_keyfile(), setup_env(), and setup_session_info().
bool sbuild::chroot::get_original | ( | ) | const |
Get the originality of the chroot.
References original.
virtual std::string sbuild::chroot::get_path | ( | ) | const [pure 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.
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, and sbuild::chroot_plain.
Referenced by get_details(), and setup_env().
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.
References priority.
Referenced by get_details(), and get_keyfile().
string_list const & sbuild::chroot::get_root_groups | ( | ) | const |
Get the groups allowed to access the chroot as root.
Members of these groups can switch to root without authenticating themselves.
References root_groups.
Referenced by get_details(), and get_keyfile().
string_list const & sbuild::chroot::get_root_users | ( | ) | const |
Get the users allowed to access the chroot as root.
Members of these users can switch to root without authenticating themselves.
References root_users.
Referenced by get_details(), and get_keyfile().
bool sbuild::chroot::get_run_setup_scripts | ( | ) | const |
Check if chroot setup scripts will be run.
References run_setup_scripts.
Referenced by get_details().
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.
References script_config.
Referenced by get_details(), get_keyfile(), and setup_env().
virtual chroot::session_flags sbuild::chroot::get_session_flags | ( | chroot const & | chroot | ) | const [pure virtual] |
Get the session flags of the chroot.
These determine how the Session controlling the chroot will operate.
chroot | the chroot to use. |
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_block_device, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
sbuild::chroot::session_flags sbuild::chroot::get_session_flags | ( | ) | const |
Get the session flags of the chroot.
These determine how the Session controlling the chroot will operate.
References facets.
Referenced by get_details(), sbuild::chroot_block_device::get_session_flags(), and setup_env().
std::string const & sbuild::chroot::get_session_id | ( | ) | const |
Get the session ID of the chroot.
References session_id.
Referenced by sbuild::chroot_facet_session::get_details().
string_list const & sbuild::chroot::get_users | ( | ) | const |
Get the users allowed to access the chroot.
References users.
Referenced by get_details(), and get_keyfile().
string_list sbuild::chroot::list_facets | ( | ) | const |
References facets.
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.
type | the type of setup being performed |
References setup_lock().
Referenced by setup_session_info().
void sbuild::chroot::print_details | ( | std::ostream & | stream | ) | const |
Print detailed information about the chroot to a stream.
The information is printed in plain text with one line per property.
stream | the stream to output to. |
References sbuild::_(), get_active(), and get_details().
void sbuild::chroot::remove_facet | ( | std::tr1::shared_ptr< T > | facet | ) | [inline] |
void sbuild::chroot::remove_facet | ( | ) | [inline] |
References facets.
Referenced by sbuild::chroot_facet_union::set_union_type().
void sbuild::chroot::replace_facet | ( | std::tr1::shared_ptr< T > | facet | ) | [inline] |
References add_facet().
void sbuild::chroot::set_aliases | ( | string_list const & | aliases | ) |
Set the aliases of the chroot.
These are alternative names for the chroot.
aliases | a list of names. |
Referenced by set_keyfile(), and set_session_id().
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.
command_prefix | the command prefix. |
Referenced by set_keyfile().
void sbuild::chroot::set_description | ( | std::string const & | description | ) |
Set the description of the chroot.
description | the description. |
Referenced by set_keyfile().
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.
environment_filter | the filter. |
Referenced by set_keyfile().
void sbuild::chroot::set_groups | ( | string_list const & | groups | ) |
Set the users allowed to access the chroot.
groups | a list of groups. |
Referenced by set_keyfile().
void sbuild::chroot::set_keyfile | ( | chroot & | chroot, | |
keyfile const & | keyfile, | |||
string_list & | used_keys | |||
) | [protected, pure 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.
chroot | the chroot to use. | |
keyfile | the keyfile to get the properties from. | |
used_keys | a list of the keys used will be set. |
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_block_device, sbuild::chroot_directory_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, and sbuild::chroot_lvm_snapshot.
References get_active(), get_keyfile_name(), sbuild::basic_keyfile< K, P >::get_keys(), sbuild::basic_keyfile< K, P >::get_object_list_value(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_DEPRECATED, sbuild::keyfile_base::PRIORITY_DISALLOWED, sbuild::keyfile_base::PRIORITY_OBSOLETE, sbuild::keyfile_base::PRIORITY_OPTIONAL, sbuild::keyfile_base::PRIORITY_REQUIRED, set_aliases(), set_command_prefix(), set_description(), set_environment_filter(), set_groups(), set_mount_location(), set_name(), set_priority(), set_root_groups(), set_root_users(), set_script_config(), and set_users().
void sbuild::chroot::set_keyfile | ( | keyfile const & | keyfile, | |
string_list & | used_keys | |||
) |
Set the chroot properties from a keyfile.
The chroot name must have previously been set, so that the correct keyfile group may be determined.
keyfile | the keyfile to get the properties from. | |
used_keys | a list of the keys used will be set. |
References facets.
void sbuild::chroot::set_mount_location | ( | std::string const & | location | ) |
Set the mount location of the chroot.
location | the mount location. |
References sbuild::is_absname(), LOCATION_ABS, and mount_location.
Referenced by set_keyfile().
void sbuild::chroot::set_name | ( | std::string const & | name | ) |
Set the name of the chroot.
name | the name. |
Referenced by set_keyfile(), and set_session_id().
void sbuild::chroot::set_original | ( | bool | original | ) |
Set the originality of the chroot.
original | true if original, false if generated. |
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.
priority | the priority. |
Referenced by set_keyfile().
void sbuild::chroot::set_root_groups | ( | string_list const & | groups | ) |
Set the groups allowed to access the chroot as root.
Members of these groups can switch to root without authenticating themselves.
groups | a list of groups. |
References root_groups.
Referenced by set_keyfile().
void sbuild::chroot::set_root_users | ( | string_list const & | users | ) |
Set the users allowed to access the chroot as root.
Members of these users can switch to root without authenticating themselves.
users | a list of users. |
References root_users.
Referenced by set_keyfile().
void sbuild::chroot::set_run_setup_scripts | ( | bool | run_setup_scripts | ) | [protected] |
Set whether chroot setup scripts will be run.
run_setup_scripts | true if setup scripts will be run, otherwise false. |
Referenced by sbuild::chroot_plain::chroot_plain().
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.
script_config | the script configuration file. |
Referenced by set_keyfile().
void sbuild::chroot::set_session_id | ( | std::string const & | session_id | ) |
Set the session ID of the chroot.
session_id | the session ID. |
References set_aliases(), and set_name().
void sbuild::chroot::set_users | ( | string_list const & | users | ) |
Set the users allowed to access the chroot.
users | a list of users. |
Referenced by set_keyfile().
void sbuild::chroot::setup_env | ( | chroot const & | chroot, | |
environment & | env | |||
) | const [pure virtual] |
Set environment.
Set the environment that the setup scripts will see during execution.
chroot | the chroot to use. | |
env | the environment to set. |
Implemented in sbuild::chroot_block_device_base, sbuild::chroot_block_device, sbuild::chroot_directory_base, sbuild::chroot_directory, sbuild::chroot_file, sbuild::chroot_loopback, and sbuild::chroot_lvm_snapshot.
References sbuild::environment::add(), get_chroot_type(), get_description(), get_mount_location(), get_name(), get_path(), get_script_config(), get_session_flags(), sbuild::normalname(), SESSION_CLONE, SESSION_CREATE, and SESSION_PURGE.
void sbuild::chroot::setup_env | ( | environment & | env | ) | const |
Set environment.
Set the environment that the setup scripts will see during execution.
env | the environment to set. |
References facets.
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.
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, sbuild::chroot_loopback, sbuild::chroot_lvm_snapshot, and sbuild::chroot_plain.
void sbuild::chroot::setup_session_info | ( | bool | start | ) | [protected, virtual] |
Set up persistent session information.
start | true if startion, or false if ending a session. |
References FILE_LOCK, FILE_UNLOCK, get_keyfile(), get_name(), lock(), sbuild::lock::LOCK_EXCLUSIVE, SESSION_UNLINK, SESSION_WRITE, sbuild::file_lock::set_lock(), and sbuild::file_lock::unset_lock().
Referenced by sbuild::chroot_lvm_snapshot::setup_lock(), sbuild::chroot_loopback::setup_lock(), sbuild::chroot_file::setup_lock(), sbuild::chroot_directory::setup_lock(), and sbuild::chroot_block_device::setup_lock().
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.
type | the type of setup being performed | |
status | the exit status of the setup commands (0 for success, nonzero for failure). |
References setup_lock().
Chroot serialisation to a keyfile.
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.
stream | the stream to output to. | |
rhs | the chroot to output. |
Chroot initialisation from a keyfile.
string_list sbuild::chroot::aliases [private] |
Alternative names for the chroot.
Referenced by get_aliases().
string_list sbuild::chroot::command_prefix [private] |
Command prefix.
Referenced by get_command_prefix().
std::string sbuild::chroot::description [private] |
Chroot description.
Referenced by get_description().
regex sbuild::chroot::environment_filter [private] |
Environment filter regex.
Referenced by get_environment_filter().
facet_list sbuild::chroot::facets [private] |
Referenced by add_facet(), chroot(), get_details(), get_facet(), get_keyfile(), get_session_flags(), list_facets(), remove_facet(), set_keyfile(), and setup_env().
string_list sbuild::chroot::groups [private] |
Groups allowed to access the chroot.
Referenced by get_groups().
std::string sbuild::chroot::mount_location [private] |
Location to mount chroot in the filesystem (if any).
Referenced by get_mount_location(), and set_mount_location().
std::string sbuild::chroot::name [private] |
Chroot name.
Referenced by get_keyfile_name(), and get_name().
bool sbuild::chroot::original [private] |
Was the chroot automatically generated?
Referenced by get_original().
unsigned int sbuild::chroot::priority [private] |
Chroot priority.
Referenced by get_priority().
string_list sbuild::chroot::root_groups [private] |
Groups allowed to access the chroot as root.
Referenced by get_root_groups(), and set_root_groups().
string_list sbuild::chroot::root_users [private] |
Users allowed to access the chroot as root.
Referenced by get_root_users(), and set_root_users().
bool sbuild::chroot::run_setup_scripts [private] |
Run chroot setup scripts?
Referenced by get_run_setup_scripts().
std::string sbuild::chroot::script_config [private] |
Configuration of the setup and exec scripts.
Referenced by get_script_config().
std::string sbuild::chroot::session_id [private] |
Chroot session ID.
Referenced by get_keyfile_name(), and get_session_id().
string_list sbuild::chroot::users [private] |
Users allowed to access the chroot.
Referenced by get_users().