--- name: "libbde" section: "3" platform: "linux" package: "libbde-dev" version: "20240502-1+b1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/libbde" --- # libbde(3) Library to access the BitLocker Drive Encryption (BDE) format ## NAME **libbde.h** – Library to access the BitLocker Drive Encryption (BDE) format ## SYNOPSIS **#include \** 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 \. 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