fs_crypto_domain_remove()

Updated: May 06, 2022

Destroy a domain

Synopsis:

#include <fs_crypto_api.h>
#include <sys/fs_crypto.h>

int fs_crypto_domain_remove( const char *path,
                             int domain,
                             int *preply );

Arguments:

path
The path to the filesystem's mountpoint.
domain
The number of the domain that you want to remove.
preply
A pointer to a location where the function can store additional success or error information.

Library:

libfscrypto

Use the -l fscrypto option to qcc to link against this library.

Description:

The fs_crypto_domain_remove() function destroys a domain. Once a domain has been removed, the private key data used to encrypt files associated with the domain is lost, and it isn't possible to retrieve any files in the domain.

Note:
  • In order to use filesystem encryption, download the Encrypted Filesystem package from the QNX Software Center.
  • You must be in the group that owns the filesystem's mountpoint in order to remove a domain.

This function sets the variable pointed to by preply to one of the following values:

FS_CRYPTO_REPLY_COMPLETE
The domain was successfully deleted.
FS_CRYPTO_REPLY_ERRNO
See the error code for more information.
FS_CRYPTO_REPLY_INVALID
The command wasn't completed successfully.
FS_CRYPTO_REPLY_READONLY
The filesystem is mounted read-only.
FS_CRYPTO_REPLY_UNKNOWN_DOMAIN
There's no domain with the given number.

Returns:

EOK
Success.
EACCES
The calling process doesn't have permission to remove the domain.
EINVAL
Invalid arguments.

This function can also return any of the errors indicated by devctl() or open().

Classification:

QNX Neutrino

Safety:  
Cancellation point Yes
Interrupt handler No
Signal handler No
Thread Yes