QPackageRegistry Class Reference
[QtPkgManagementModule]

Key File Change Notes

Both the proc pseudo file and the disk file have the same format, and if the /proc/lids/keys file is not present, disk files are used instead.

The struct usr_key_entry is defined in SXE kernel patch file include/linux/lidsif.h

struct usr_key_entry is the (new) data record format for the key file superseding the format used in Qtopia 4.1

The key file is (now) either /proc/lids/keys (and the per-process keys in /proc/<pid>/lids_key ) OR for desktop/development ONLY (not for production) it is $QPEDIR/etc/keyfile

The key file maps keys to files.

File are identified by inode and device numbers, not paths.

(See the "installs" file for path to inode/device mapping)

Disk keyfiles are to allow desktop development and testing only, since on desktop development machines the kernel patch will typically not be installed.

It is not supported on the device to operate without /proc/lids/keys

Where binary files are writeable (all downloaded programs must be writeable) the key is embedded in the binary at install time.

In the development and testing case, the embedded key is used by the binary to authenticate itself to the server.

When the kernel contains the LIDS MAC Qt Extended patch the binary reads its key from the /proc pseudo-file /proc/self/lids_key.

See also RegistryFile.

Member Type Documentation

enum QPackageRegistry::RegistryFile

This enum specifies one of the registry files

Member Function Documentation

QPackageRegistry::QPackageRegistry ()

Construct new QPackageRegistry object

Do not use this method, instead call the instance method getInstance()

See also getInstance().

QPackageRegistry::~QPackageRegistry ()   [virtual]

Destroy the QPackageRegistry object

int QPackageRegistry::bootstrap ( const QString & installRoot )

Bootstrap the qtopia image with sxe control files.

Creates (or truncates) new empty SXE control files, ready to be updated by the scanner. If the installRoot already contains non-empty files then it will refuse to overwrite them.

The return code of this is used as a unix exec return code, ie 0 is success non-zero is failure.

const unsigned char * QPackageRegistry::getClientKey ( unsigned char progId )

Return the key associated the specified program id progId.

As a host binary sxe_installer doesnt have access to this method in qtransportauth_qws.cpp, so reimplement it here.

In the SXE installer case assume there is a one-to-one mapping from keys to progId's since the installer ensures that.

QPackageRegistry * QPackageRegistry::getInstance ()   [static]

Return a singleton instance of the QPackageRegistry object for this process.

void QPackageRegistry::initProgramInfo ( SxeProgramInfo & pi )

Initialise an SxeProgramInfo pi which can then be used to register a sequence of same-domain binaries.

A new key and a new program id is created and stored in pi. The other fields are unchanged.

The keyfile.sequence file is used to track and issue new program id numbers.

bool QPackageRegistry::isInstalledProgram ( QTransportAuth::Data & connectionData )

This function is deprecated.

Return true if the connectionData connection is from an installed program, ie not one which is part of the base software.

The program is installed software if it is installed in Qtopia::packagePath()

void QPackageRegistry::lockManifest ( bool & success )   [slot]

Obtain a Qtopia::lockFile() on the manifest file. This represents locking the QPackageRegistry database system to allow write operations to be done by this process.

If successfully locked, the method sets success to true; otherwise it sets it to false.

Call this method to obtain the lock before performing any write operations to the SXE database system.

This should be matched by a call to unlockManifest()

See also unlockManifest().

void QPackageRegistry::registerBinary ( SxeProgramInfo & pi )   [slot]

Register a qtopia binary with the SXE system. The path to the binary is:

pi.absolutePath()

where the SxeProgramInfo pi contains all the information about the binary.

Note that binaries with the same domain (SXE policy profile) and binaries from the same package are coalesced into the same Program Id, and thus use the same secret key.

The SxeProgramInfo pi if uninitialised is modified by creating a new random key and program id. The id and key fields if initialised are used to register the binary.

See also SxeProgramInfo.

QString QPackageRegistry::sxeConfPath () const   [virtual]

Return the authoritative path for where the SXE database files, such as installs, and manifest, are stored.

The directory must be writeable.

Current implementation is simply Qtopia::qtopiaDir() + "etc"

void QPackageRegistry::unlockManifest ()   [slot]

Release the lock on the manifest file.

See also lockManifest().

bool QPackageRegistry::unregisterPackageBinaries ( const QString & packagePath )

Unregisters a package's binaries from the SXE system for the given packagePath

returns true if the removal of the registration was successful; otherwise returns false

Member Variable Documentation

const QString QPackageRegistry::binInstallPath

returns the QString name of the relative binary path, where SXE controlled executables are installed. Concatenate this with paths from installPaths() to find full paths which may contain binaries.

See also Qtopia::installPaths().

const QString QPackageRegistry::installsFileName

returns the QString name of the installs file, part of the SXE database

See also sxeConfPath().

const QString QPackageRegistry::manifestFileName

returns the QString name of the manifest file, part of the SXE database

See also sxeConfPath().

const QString QPackageRegistry::profilesFileName

returns the QString name of the profiles file, part of the SXE database

See also sxeConfPath().

const QString QPackageRegistry::qlLibInstallPath

returns the QString name of the relative quicklaunch binary path, where SXE controlled quicklaunched executables are installed. Concatenate this with paths from installPaths() to find full paths which may contain .so files.

See also Qtopia::installPaths().