Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
libbde(3)		     Library Functions Manual		       libbde(3)

NAME
     libbde.h -- Library to access the BitLocker Drive Encryption (BDE) format

SYNOPSIS
     #include <libbde.h>

     Support functions

     const char *
     libbde_get_version(void);

     int
     libbde_get_access_flags_read(void);

     int
     libbde_get_codepage(int *codepage, libbde_error_t **error);

     int
     libbde_set_codepage(int codepage, libbde_error_t **error);

     int
     libbde_check_volume_signature(const char *filename,
	 libbde_error_t **error);

     Available when compiled with wide character string support:

     int
     libbde_check_volume_signature_wide(const wchar_t *filename,
	 libbde_error_t **error);

     Available when compiled with libbfio support:

     int
     libbde_check_volume_signature_file_io_handle(libbfio_handle_t *file_io_handle,
	 libbde_error_t **error);

     Notify functions

     void
     libbde_notify_set_verbose(int verbose);

     int
     libbde_notify_set_stream(FILE *stream, libbde_error_t **error);

     int
     libbde_notify_stream_open(const char *filename, libbde_error_t **error);

     int
     libbde_notify_stream_close(libbde_error_t **error);

     Error functions

     void
     libbde_error_free(libbde_error_t **error);

     int
     libbde_error_fprint(libbde_error_t *error, FILE *stream);

     int
     libbde_error_sprint(libbde_error_t *error, char *string, size_t size);

     int
     libbde_error_backtrace_fprint(libbde_error_t *error, FILE *stream);

     int
     libbde_error_backtrace_sprint(libbde_error_t *error, char *string,
	 size_t size);

     Volume functions

     int
     libbde_volume_initialize(libbde_volume_t **volume, libbde_error_t **error);

     int
     libbde_volume_free(libbde_volume_t **volume, libbde_error_t **error);

     int
     libbde_volume_signal_abort(libbde_volume_t *volume,
	 libbde_error_t **error);

     int
     libbde_volume_open(libbde_volume_t *volume, const char *filename,
	 int access_flags, libbde_error_t **error);

     int
     libbde_volume_close(libbde_volume_t *volume, libbde_error_t **error);

     int
     libbde_volume_is_locked(libbde_volume_t *volume, libbde_error_t **error);

     int
     libbde_volume_unlock(libbde_volume_t *volume, libbde_error_t **error);

     ssize_t
     libbde_volume_read_buffer(libbde_volume_t *volume, void *buffer,
	 size_t buffer_size, libbde_error_t **error);

     ssize_t
     libbde_volume_read_buffer_at_offset(libbde_volume_t *volume, void *buffer,
	 size_t buffer_size, off64_t offset, libbde_error_t **error);

     off64_t
     libbde_volume_seek_offset(libbde_volume_t *volume, off64_t offset,
	 int whence, libbde_error_t **error);

     int
     libbde_volume_get_offset(libbde_volume_t *volume, off64_t *offset,
	 libbde_error_t **error);

     int
     libbde_volume_get_size(libbde_volume_t *volume, size64_t *size,
	 libbde_error_t **error);

     int
     libbde_volume_get_encryption_method(libbde_volume_t *volume,
	 uint16_t *encryption_method, libbde_error_t **error);

     int
     libbde_volume_get_volume_identifier(libbde_volume_t *volume,
	 uint8_t *guid_data, size_t guid_data_size, libbde_error_t **error);

     int
     libbde_volume_get_creation_time(libbde_volume_t *volume,
	 uint64_t *filetime, libbde_error_t **error);

     int
     libbde_volume_get_utf8_description_size(libbde_volume_t *volume,
	 size_t *utf8_string_size, libbde_error_t **error);

     int
     libbde_volume_get_utf8_description(libbde_volume_t *volume,
	 uint8_t *utf8_string, size_t utf8_string_size, libbde_error_t **error);

     int
     libbde_volume_get_utf16_description_size(libbde_volume_t *volume,
	 size_t *utf16_string_size, libbde_error_t **error);

     int
     libbde_volume_get_utf16_description(libbde_volume_t *volume,
	 uint16_t *utf16_string, size_t utf16_string_size,
	 libbde_error_t **error);

     int
     libbde_volume_get_number_of_key_protectors(libbde_volume_t *volume,
	 int *number_of_key_protectors, libbde_error_t **error);

     int
     libbde_volume_get_key_protector_by_index(libbde_volume_t *volume,
	 int key_protector_index, libbde_key_protector_t **key_protector,
	 libbde_error_t **error);

     int
     libbde_volume_set_keys(libbde_volume_t *volume,
	 const uint8_t *full_volume_encryption_key,
	 size_t full_volume_encryption_key_size, const uint8_t *tweak_key,
	 size_t tweak_key_size, libbde_error_t **error);

     int
     libbde_volume_set_utf8_password(libbde_volume_t *volume,
	 const uint8_t *utf8_string, size_t utf8_string_length,
	 libbde_error_t **error);

     int
     libbde_volume_set_utf16_password(libbde_volume_t *volume,
	 const uint16_t *utf16_string, size_t utf16_string_length,
	 libbde_error_t **error);

     int
     libbde_volume_set_utf8_recovery_password(libbde_volume_t *volume,
	 const uint8_t *utf8_string, size_t utf8_string_length,
	 libbde_error_t **error);

     int
     libbde_volume_set_utf16_recovery_password(libbde_volume_t *volume,
	 const uint16_t *utf16_string, size_t utf16_string_length,
	 libbde_error_t **error);

     int
     libbde_volume_read_startup_key(libbde_volume_t *volume,
	 const char *filename, libbde_error_t **error);

     int
     libbde_volume_read_startup_key_wide(libbde_volume_t *volume,
	 const wchar_t *filename, libbde_error_t **error);

     Available when compiled with wide character string support:

     int
     libbde_volume_open_wide(libbde_volume_t *volume, const wchar_t *filename,
	 int access_flags, libbde_error_t **error);

     Available when compiled with libbfio support:

     int
     libbde_volume_open_file_io_handle(libbde_volume_t *volume,
	 libbfio_handle_t *file_io_handle, int access_flags,
	 libbde_error_t **error);

     int
     libbde_volume_read_startup_key_file_io_handle(libbde_volume_t *volume,
	 libbfio_handle_t *file_io_handle, libbde_error_t **error);

     Key protector functions

     int
     libbde_key_protector_free(libbde_key_protector_t **key_protector,
	 libbde_error_t **error);

     int
     libbde_key_protector_get_identifier(libbde_key_protector_t *key_protector,
	 uint8_t *guid_data, size_t guid_data_size, libbde_error_t **error);

     int
     libbde_key_protector_get_type(libbde_key_protector_t *key_protector,
	 uint16_t *type, libbde_error_t **error);

DESCRIPTION
     The libbde_get_version() function is used to retrieve the library version.

RETURN VALUES
     Most  of  the functions return NULL or -1 on error, dependent on the return
     type.  For the actual return values see "libbde.h".

ENVIRONMENT
     None

FILES
     None

NOTES
     libbde can be compiled with wide character support (wchar_t).

     To  compile  libbde  with	 wide	character   support   use:   ./configure
     --enable-wide-character-type=yes
      or define: _UNICODE
      or UNICODE
      during compilation.

     LIBBDE_WIDE_CHARACTER_TYPE
      in  libbde/features.h can be used to determine if libbde was compiled with
     wide character support.

BUGS
     Please  report  bugs  of  any  kind   on	the   project	issue	tracker:
     https://github.com/libyal/libbde/issues

AUTHOR
     These man pages are generated from "libbde.h".

COPYRIGHT
     Copyright (C) 2011-2024, Joachim Metz <joachim.metz@gmail.com>.

     This  is free software; see the source for copying conditions.  There is NO
     warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SEE ALSO
     the libbde.h include file

libbde				   May 2, 2024			       libbde(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=libbde&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help