---
name: "libluksde"
section: "3"
platform: "linux"
package: "libluksde-dev"
version: "20240503-1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/libluksde"
---

# libluksde(3)

Library to access the Linux Unified Key Setup (LUKS) Disk Encryption format

## NAME

**libluksde.h** – Library to access the Linux Unified Key Setup (LUKS) Disk Encryption format

## SYNOPSIS

**#include \<libluksde.h\>**

Support functions

*const* *char* *\**\

**libluksde\_get\_version**(*void*);

*int*\

**libluksde\_get\_access\_flags\_read**(*void*);

*int*\

**libluksde\_get\_codepage**(*int \*codepage*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_set\_codepage**(*int codepage*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_check\_volume\_signature**(*const char \*filename*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_check\_volume\_signature\_wide**(*const wchar\_t \*filename*, *libluksde\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libluksde\_check\_volume\_signature\_file\_io\_handle**(*libbfio\_handle\_t \*file\_io\_handle*, *libluksde\_error\_t \*\*error*);

Notify functions

*void*\

**libluksde\_notify\_set\_verbose**(*int verbose*);

*int*\

**libluksde\_notify\_set\_stream**(*FILE \*stream*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_notify\_stream\_open**(*const char \*filename*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_notify\_stream\_close**(*libluksde\_error\_t \*\*error*);

Error functions

*void*\

**libluksde\_error\_free**(*libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_error\_fprint**(*libluksde\_error\_t \*error*, *FILE \*stream*);

*int*\

**libluksde\_error\_sprint**(*libluksde\_error\_t \*error*, *char \*string*, *size\_t size*);

*int*\

**libluksde\_error\_backtrace\_fprint**(*libluksde\_error\_t \*error*, *FILE \*stream*);

*int*\

**libluksde\_error\_backtrace\_sprint**(*libluksde\_error\_t \*error*, *char \*string*, *size\_t size*);

Volume functions

*int*\

**libluksde\_volume\_initialize**(*libluksde\_volume\_t \*\*volume*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_free**(*libluksde\_volume\_t \*\*volume*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_signal\_abort**(*libluksde\_volume\_t \*volume*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_open**(*libluksde\_volume\_t \*volume*, *const char \*filename*, *int access\_flags*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_close**(*libluksde\_volume\_t \*volume*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_is\_locked**(*libluksde\_volume\_t \*volume*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_unlock**(*libluksde\_volume\_t \*volume*, *libluksde\_error\_t \*\*error*);

*ssize\_t*\

**libluksde\_volume\_read\_buffer**(*libluksde\_volume\_t \*volume*, *void \*buffer*, *size\_t buffer\_size*, *libluksde\_error\_t \*\*error*);

*ssize\_t*\

**libluksde\_volume\_read\_buffer\_at\_offset**(*libluksde\_volume\_t \*volume*, *void \*buffer*, *size\_t buffer\_size*, *off64\_t offset*, *libluksde\_error\_t \*\*error*);

*off64\_t*\

**libluksde\_volume\_seek\_offset**(*libluksde\_volume\_t \*volume*, *off64\_t offset*, *int whence*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_get\_offset**(*libluksde\_volume\_t \*volume*, *off64\_t \*offset*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_get\_size**(*libluksde\_volume\_t \*volume*, *size64\_t \*size*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_get\_encryption\_method**(*libluksde\_volume\_t \*volume*, *int \*encryption\_method*, *int \*encryption\_chaining\_mode*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_get\_volume\_identifier**(*libluksde\_volume\_t \*volume*, *uint8\_t \*uuid\_data*, *size\_t uuid\_data\_size*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_set\_key**(*libluksde\_volume\_t \*volume*, *const uint8\_t \*master\_key*, *size\_t master\_key\_size*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_set\_utf8\_password**(*libluksde\_volume\_t \*volume*, *const uint8\_t \*utf8\_string*, *size\_t utf8\_string\_length*, *libluksde\_error\_t \*\*error*);

*int*\

**libluksde\_volume\_set\_utf16\_password**(*libluksde\_volume\_t \*volume*, *const uint16\_t \*utf16\_string*, *size\_t utf16\_string\_length*, *libluksde\_error\_t \*\*error*);

Available when compiled with wide character string support:

*int*\

**libluksde\_volume\_open\_wide**(*libluksde\_volume\_t \*volume*, *const wchar\_t \*filename*, *int access\_flags*, *libluksde\_error\_t \*\*error*);

Available when compiled with libbfio support:

*int*\

**libluksde\_volume\_open\_file\_io\_handle**(*libluksde\_volume\_t \*volume*, *libbfio\_handle\_t \*file\_io\_handle*, *int access\_flags*, *libluksde\_error\_t \*\*error*);

## DESCRIPTION

The **libluksde\_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 "libluksde.h".

## ENVIRONMENT

None

## FILES

None

## NOTES

libluksde can be compiled with wide character support (wchar\_t).

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

*LIBLUKSDE\_WIDE\_CHARACTER\_TYPE*\
  in libluksde/features.h can be used to determine if libluksde was compiled with wide character support.

## BUGS

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

## AUTHOR

These man pages are generated from "libluksde.h".

## COPYRIGHT

Copyright (C) 2013-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 libluksde.h include file