<para><literal>-c &lt;configfile&gt;</literal></para>

      <para><literal>-c &lt;configfile&gt;</literal></para>

      <para>The configfile to use for connecting to the store. Default is

      <para>The configfile to use for connecting to the store. Default is

    </refsection>

    </refsection>

    <refsection>

    <refsection>

    <para><literal>bbstoreaccounts</literal> uses the Box Backup server

    <para><literal>bbstoreaccounts</literal> uses the Box Backup server

    configuration file, usually located in

    configuration file, usually located in

  </refsection>

  </refsection>

  <refsection>

  <refsection>

    <para><literal>bbackupctl</literal> uses the Box Backup client

    <para><literal>bbackupctl</literal> uses the Box Backup client

    configuration file, usually located in

    configuration file, usually located in

    usually located in the installation directory, and is named

    usually located in the installation directory, and is named

    <filename>bbackupd.conf</filename> as well.</para>

    <filename>bbackupd.conf</filename> as well.</para>

  </refsection>

  </refsection>

        <programlisting>mkdir /tmp/boxbackupRepository                        # Create the directory

        <programlisting>mkdir /tmp/boxbackupRepository                        # Create the directory

chown _bbstored /tmp/boxbackupRepository/             # Change the owner to the new boxbackup daemon user

chown _bbstored /tmp/boxbackupRepository/             # Change the owner to the new boxbackup daemon user

#substitute 1024 with the desired blocksize

#substitute 1024 with the desired blocksize

#substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located

#substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located

        hostname is tricky as it is used for two things: The name of the

        hostname is tricky as it is used for two things: The name of the

        server in the certificate and the address the server is listening on.

        server in the certificate and the address the server is listening on.

        Since you might be using NAT, might move the server around or the

        Since you might be using NAT, might move the server around or the

        domain name might change, choose a name that describes the server.

        domain name might change, choose a name that describes the server.

        When the network address of the server changes, you need to update the

        When the network address of the server changes, you need to update the

        <literal>ListenAddresses</literal> directive in the

        <literal>ListenAddresses</literal> directive in the

        <para>This last step outputs 5 instructions that you must execute to

        <para>This last step outputs 5 instructions that you must execute to

        the letter. A lot of questions are raised on the mailing list because

        the letter. A lot of questions are raised on the mailing list because

          <para>To setup the basic key structure, do the following:</para>

          <para>To setup the basic key structure, do the following:</para>

          <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you

          <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you

          get an OpenSSL error)</para>

          get an OpenSSL error)</para>

          request (CSR) for you. Transfer it to the machine with your CA, then

          request (CSR) for you. Transfer it to the machine with your CA, then

          do:</para>

          do:</para>

          <para>This signs the certificate for the server. Follow the

          <para>This signs the certificate for the server. Follow the

          instructions in the output on which files to install on the server.

          instructions in the output on which files to install on the server.

          0, for example, 1 or 75AB23C. Then on the backup store server,

          0, for example, 1 or 75AB23C. Then on the backup store server,

          create the account with:</para>

          create the account with:</para>

          <para>This looks complicated. The numbers are, in order:</para>

          <para>This looks complicated. The numbers are, in order:</para>

          <para>Sign this CSR with this command:</para>

          <para>Sign this CSR with this command:</para>

          <para>Don't forget to check that the embedded account number is

          <para>Don't forget to check that the embedded account number is

          correct! Then send the two files back to the user, as instructed by

          correct! Then send the two files back to the user, as instructed by

        <para>The backup client has to be run as root, because it needs to

        <para>The backup client has to be run as root, because it needs to

        read all your files to back them up, although it is possible to back

        read all your files to back them up, although it is possible to back

        up a single user's files by running it as that user. (Tip: specify a

        up a single user's files by running it as that user. (Tip: specify a

        alternate config file as the first argument to

        alternate config file as the first argument to

        <command>bbackupd</command>). However, it will fall over if you don't

        <command>bbackupd</command>). However, it will fall over if you don't

        give yourself read access to one of your files.</para>

        give yourself read access to one of your files.</para>

          the configuration files and generate a private key and certificate

          the configuration files and generate a private key and certificate

          request.</para>

          request.</para>

              role="bold">999 hostname</emphasis> /var/bbackupd <emphasis

              role="bold">999 hostname</emphasis> /var/bbackupd <emphasis

              role="bold">/home</emphasis></programlisting>

              role="bold">/home</emphasis></programlisting>

          basic bbackupd configuration.</para>

          basic bbackupd configuration.</para>

          <para>You can then run the daemon (as root) by running

          <para>You can then run the daemon (as root) by running

          to your system's startup scripts. The first time it's run it will

          to your system's startup scripts. The first time it's run it will

          upload everything. Interrupting it and restarting it will only

          upload everything. Interrupting it and restarting it will only

          upload files which were not uploaded before - it's very

          upload files which were not uploaded before - it's very

          <para>Remember to make a traditional backup of the keys file, as

          <para>Remember to make a traditional backup of the keys file, as

          instructed. You cannot restore files without it.</para>

          instructed. You cannot restore files without it.</para>

          will make things easier if you need to restore files. But only the

          will make things easier if you need to restore files. But only the

          keys are absolutely essential.</para>

          keys are absolutely essential.</para>

        <section>

        <section>

          <title>Adding and removing backed up locations</title>

          <title>Adding and removing backed up locations</title>

          remove directories to back up - see comments in this file for help.

          remove directories to back up - see comments in this file for help.

          Send bbackupd a HUP signal after you modify it.</para>

          Send bbackupd a HUP signal after you modify it.</para>

            here -- they may be different for your system.</para>

            here -- they may be different for your system.</para>

          </important>

          </important>

Setup bbackupd config utility.

Setup bbackupd config utility.

Configuration:

Configuration:

   Account: 51

   Account: 51

   Server hostname: server.example.com

   Server hostname: server.example.com

   Directories to back up:

   Directories to back up:

WARNING: Directories not checked against mountpoints. Check mounted filesystems manually.

WARNING: Directories not checked against mountpoints. Check mounted filesystems manually.

Generating private key...

Generating private key...

 [OpenSSL output omitted]

 [OpenSSL output omitted]

Generating keys for file backup

Generating keys for file backup

===================================================================

===================================================================

What you need to do now...

What you need to do now...

   This should be a secure offsite backup.

   This should be a secure offsite backup.

   Without it, you cannot restore backups. Everything else can

   Without it, you cannot restore backups. Everything else can

   be replaced. But this cannot.

   be replaced. But this cannot.

   KEEP IT IN A SAFE PLACE, OTHERWISE YOUR BACKUPS ARE USELESS.

   KEEP IT IN A SAFE PLACE, OTHERWISE YOUR BACKUPS ARE USELESS.

   to the administrator of the backup server, and ask for it to

   to the administrator of the backup server, and ask for it to

   be signed.

   be signed.

3) The administrator will send you two files. Install them as

3) The administrator will send you two files. Install them as

   after checking their authenticity.

   after checking their authenticity.

4) You may wish to read the configuration file

4) You may wish to read the configuration file

   and adjust as appropraite.

   and adjust as appropraite.

   There are some notes in it on excluding files you do not

   There are some notes in it on excluding files you do not

   wish to be backed up.

   wish to be backed up.

5) Review the script

5) Review the script

   and check that it will email the right person when the store

   and check that it will email the right person when the store

   becomes full. This is important -- when the store is full, no

   becomes full. This is important -- when the store is full, no

   more files will be backed up. You want to know about this.

   more files will be backed up. You want to know about this.

6) Start the backup daemon with the command

6) Start the backup daemon with the command

   in /etc/rc.local, or your local equivalent.

   in /etc/rc.local, or your local equivalent.

   Note that bbackupd must run as root.

   Note that bbackupd must run as root.

          <programlisting>StoreHostname = localhost

          <programlisting>StoreHostname = localhost

AccountNumber = 0x2

AccountNumber = 0x2

DataDirectory = /var/run/boxbackup

DataDirectory = /var/run/boxbackup

CommandSocket = /var/run/box/bbackupd.sock

CommandSocket = /var/run/box/bbackupd.sock

UpdateStoreInterval = 86400

UpdateStoreInterval = 86400

        <para>The command line syntax is:</para>

        <para>The command line syntax is:</para>

        <para>The -q option reduces the amount of output the program emits,

        <para>The -q option reduces the amount of output the program emits,

        and -c allows an alternative configuration file to be

        and -c allows an alternative configuration file to be

        <para>Use bbackupd-config to write a configuration file in snapshot

        <para>Use bbackupd-config to write a configuration file in snapshot

        mode, and then run the following command as a cron job.</para>

        mode, and then run the following command as a cron job.</para>

        <para>This will cause the backup daemon to upload all changed files

        <para>This will cause the backup daemon to upload all changed files

        immediately. <emphasis role="bold">bbackupctl</emphasis> will exit

        immediately. <emphasis role="bold">bbackupctl</emphasis> will exit

          for this account. Either use the usage command in interactive mode,

          for this account. Either use the usage command in interactive mode,

          or type:</para>

          or type:</para>

          <para>to show the space used as a single command.</para>

          <para>to show the space used as a single command.</para>

        </section>

        </section>

          the limits. To display the space used on the server for an account,

          the limits. To display the space used on the server for an account,

          use:</para>

          use:</para>

          <para>To adjust the soft and hard limits on an account, use:</para>

          <para>To adjust the soft and hard limits on an account, use:</para>

          <para>You do not need to restart the server.</para>

          <para>You do not need to restart the server.</para>

        </section>

        </section>

        utility does this and more.</para>

        utility does this and more.</para>

        <para>You don't provide any login information to it, as it just picks

        <para>You don't provide any login information to it, as it just picks

        root so it can find everything it needs.</para>

        root so it can find everything it needs.</para>

        <para>Full documentation can be found in the <ulink

        <para>Full documentation can be found in the <ulink

          <programlisting>[pthomsen@host bbackupquery]$ bbackupquery 

          <programlisting>[pthomsen@host bbackupquery]$ bbackupquery 

Box Backup Query Tool  v0.10, (c) Ben Summers and contributors 2003-2006

Box Backup Query Tool  v0.10, (c) Ben Summers and contributors 2003-2006

Connecting to store...

Connecting to store...

Handshake with store...

Handshake with store...

Login to store...

Login to store...

          regularly, and check its output. You can run the command manually as

          regularly, and check its output. You can run the command manually as

          follows:</para>

          follows:</para>

          <para>This command will report all the differences found between the

          <para>This command will report all the differences found between the

          store and the files on disc. It will download everything, so may

          store and the files on disc. It will download everything, so may

          <para>If you would like to do a "quick" check which just downloads

          <para>If you would like to do a "quick" check which just downloads

          file checksums and compares against that, then run:</para>

          file checksums and compares against that, then run:</para>

          <para>However, this does not check that the file attributes are

          <para>However, this does not check that the file attributes are

          correct, and since the checksums are generated on the client they

          correct, and since the checksums are generated on the client they

          file safe, you indirectly keep your entire backup safe.</para>

          file safe, you indirectly keep your entire backup safe.</para>

          <para>The first step is to recreate the configuration of the backup

          <para>The first step is to recreate the configuration of the backup

          with your keys. But if you're recreating it, all you really need is

          with your keys. But if you're recreating it, all you really need is

          to have got the login infomation correct (ie the certs and

          to have got the login infomation correct (ie the certs and

          keys).</para>

          keys).</para>

          <para>Type:</para>

          <para>Type:</para>

          <para>to run it in interactive mode.</para>

          <para>to run it in interactive mode.</para>

          <para>Firstly, run bbackupquery in interactive mode. It behaves in a

          <para>Firstly, run bbackupquery in interactive mode. It behaves in a

          similar manner to a command line sftp client.</para>

          similar manner to a command line sftp client.</para>

          <para>Then navigate to the directory containing the file you want,

          <para>Then navigate to the directory containing the file you want,

          using list, cd and pwd.</para>

          using list, cd and pwd.</para>

        <para>First, run the check utility, and see what errors it

        <para>First, run the check utility, and see what errors it

        reports.</para>

        reports.</para>

        <para>This will take some time, and use a fair bit of memory (about 16

        <para>This will take some time, and use a fair bit of memory (about 16

        bytes per file and directory). If the output looks plausible and

        bytes per file and directory). If the output looks plausible and

        reports errors which need fixing, run it again but with the fix

        reports errors which need fixing, run it again but with the fix

        flag:</para>

        flag:</para>

        <para>This will fix any errors, and remove unrecoverable files.

        <para>This will fix any errors, and remove unrecoverable files.

        Directories will be recreated if necessary.</para>

        Directories will be recreated if necessary.</para>

        configuration file locations to daemons and programs. For

        configuration file locations to daemons and programs. For

        example</para>

        example</para>

        <para>(daemons specify the name as the first argument, utility

        <para>(daemons specify the name as the first argument, utility

        programs with the -c option).</para>

        programs with the -c option).</para>

      <para>Follow the installation instructions, but install the executable

      <para>Follow the installation instructions, but install the executable

      files manually to somewhere in your home directory. Then use

      files manually to somewhere in your home directory. Then use

      bbackupd-config to configure the daemon, but use a directory other than

      bbackupd-config to configure the daemon, but use a directory other than

      <para>All directories you specify to be backed up must be readable, and

      <para>All directories you specify to be backed up must be readable, and

      all files must be owned by the user and readable to that user.</para>

      all files must be owned by the user and readable to that user.</para>

    <para><literal>bbstoreaccounts</literal> uses the Box Backup server

    <para><literal>bbstoreaccounts</literal> uses the Box Backup server

    configuration file, usually located in

    configuration file, usually located in

  </refsection>

  </refsection>

  <refsection>

  <refsection>

      <para>This builds two parcels of binaries and scripts, 'backup-client'

      <para>This builds two parcels of binaries and scripts, 'backup-client'

      and 'backup-server'. The generated installation scripts assumes you want

      and 'backup-server'. The generated installation scripts assumes you want

      everything installed in <emphasis

      everything installed in <emphasis

      <para>Optionally, type <emphasis role="bold">make test</emphasis> to run

      <para>Optionally, type <emphasis role="bold">make test</emphasis> to run

      all the tests.</para>

      all the tests.</para>

    <para><literal>bbackupquery</literal> uses the Box Backup client

    <para><literal>bbackupquery</literal> uses the Box Backup client

    configuration file, usually located in

    configuration file, usually located in

    usually located in the installation directory, and is named

    usually located in the installation directory, and is named

    <filename>bbackupd.conf</filename> as well.</para>

    <filename>bbackupd.conf</filename> as well.</para>

  </refsection>

  </refsection>

        <listitem>

        <listitem>

          <para><literal>configdir</literal>: The directory path where

          <para><literal>configdir</literal>: The directory path where

          configuration files are located. Usually this is

          configuration files are located. Usually this is

          be written in this directory.</para>

          be written in this directory.</para>

        </listitem>

        </listitem>

public:

public:

	void Initialise(const std::string& rConfigFilename = 

	void Initialise(const std::string& rConfigFilename = 

	int GetNumDiscSets() {return mSetList.size();}

	int GetNumDiscSets() {return mSetList.size();}

	// --------------------------------------------------------------------------

	// --------------------------------------------------------------------------

    raidfile-config config-dir block-size dir0 [dir1 dir2]

    raidfile-config config-dir block-size dir0 [dir1 dir2]

Parameters:

Parameters:

    block-size        must be a power of two, and usually the block or

    block-size        must be a power of two, and usually the block or

                      fragment size of your file system

                      fragment size of your file system

    dir0, dir1, dir2  are the directories used as the root of the raid

    dir0, dir1, dir2  are the directories used as the root of the raid

	#define BOX_GET_DEFAULT_BBSTORED_CONFIG_FILE \

	#define BOX_GET_DEFAULT_BBSTORED_CONFIG_FILE \

		GetDefaultConfigFilePath("bbstored.conf").c_str()

		GetDefaultConfigFilePath("bbstored.conf").c_str()

#else

#else

#endif

#endif

#endif // BOXPORTSANDFILES__H

#endif // BOXPORTSANDFILES__H

The file data is encrypted with AES in CBC mode, with a 256 bit key (max length). Blowfish is used elsewhere because the larger block size of AES, while more secure, would be terribly space inefficient. Note that Blowfish may also be used when older versions of OpenSSL are in use, and for backwards compatibility with older versions.

The file data is encrypted with AES in CBC mode, with a 256 bit key (max length). Blowfish is used elsewhere because the larger block size of AES, while more secure, would be terribly space inefficient. Note that Blowfish may also be used when older versions of OpenSSL are in use, and for backwards compatibility with older versions.

Code for review: BackupClientCryptoKeys_Setup()

Code for review: BackupClientCryptoKeys_Setup()

in lib/backupclient/BackupClientCryptoKeys.cpp

in lib/backupclient/BackupClientCryptoKeys.cpp

SUBTITLE Controller

SUBTITLE Controller

In the code, files are referenced using an integer set number, and a filename within that set. For example, (0, "dir/subdir/filename.ext"). The RAID file controller turns this into actual physcial filenames transparently.

In the code, files are referenced using an integer set number, and a filename within that set. For example, (0, "dir/subdir/filename.ext"). The RAID file controller turns this into actual physcial filenames transparently.

        working-dir [backup directories]

        working-dir [backup directories]

Parameters:

Parameters:

    backup-mode         is lazy or snapshot:

    backup-mode         is lazy or snapshot:

        lazy mode       runs continously, uploading files over a specified age

        lazy mode       runs continously, uploading files over a specified age

        snapshot mode   uploads a snapshot of the filesystem when instructed

        snapshot mode   uploads a snapshot of the filesystem when instructed

}

}

# default locations

# default locations

# command line parameters

# command line parameters

my ($config_dir,$backup_mode,$account_num,$server,$working_dir,@tobackup) = @ARGV;

my ($config_dir,$backup_mode,$account_num,$server,$working_dir,@tobackup) = @ARGV;

   more files will be backed up. You want to know about this.

   more files will be backed up. You want to know about this.

6) Start the backup daemon with the command

6) Start the backup daemon with the command

   in /etc/rc.local, or your local equivalent.

   in /etc/rc.local, or your local equivalent.

   Note that bbackupd must run as root.

   Note that bbackupd must run as root.

__E

__E

7) Set up a cron job to run whenever you want a snapshot of the

7) Set up a cron job to run whenever you want a snapshot of the

   file system to be taken. Run the command

   file system to be taken. Run the command

__E

__E

}

}

print <<__E;

print <<__E;

#ifndef BACKUPCONSTANTS__H

#ifndef BACKUPCONSTANTS__H

#define BACKUPCONSTANTS__H

#define BACKUPCONSTANTS__H

// 15 minutes to timeout (milliseconds)

// 15 minutes to timeout (milliseconds)

#define	BACKUP_STORE_TIMEOUT			(15*60*1000)

#define	BACKUP_STORE_TIMEOUT			(15*60*1000)

    bbstored-config config-dir server-hostname username [raidfile-config]

    bbstored-config config-dir server-hostname username [raidfile-config]

Parameters:

Parameters:

    server-hostname  is the hostname that clients will use to connect to

    server-hostname  is the hostname that clients will use to connect to

                     this server

                     this server

    username         is the user to run the server under

    username         is the user to run the server under

}

}

# default locations

# default locations

# command line parameters

# command line parameters

my ($config_dir,$server,$username,$raidfile_config) = @ARGV;

my ($config_dir,$server,$username,$raidfile_config) = @ARGV;

4) Create accounts with bbstoreaccounts

4) Create accounts with bbstoreaccounts

5) Start the backup store daemon with the command

5) Start the backup store daemon with the command

   in /etc/rc.local, or your local equivalent.

   in /etc/rc.local, or your local equivalent.

===================================================================

===================================================================

			{

			{

				$local_install_dir = "/usr/local/$dest";

				$local_install_dir = "/usr/local/$dest";

			}

			}

			print SCRIPT "install $name " .

			print SCRIPT "install $name " .

				"\$DESTDIR$local_install_dir\n";

				"\$DESTDIR$local_install_dir\n";

		}

		}