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

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

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

       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.

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

       None

       None

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

       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.

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

       the libluksde.h include file

libluksde                                       January 21, 2022                                    libluksde(3)

#include<libluksde.h>

       Support functions

       constchar*libluksde_get_version(void);

       intlibluksde_get_access_flags_read(void);

       intlibluksde_get_codepage(int*codepage, libluksde_error_t**error);

       intlibluksde_set_codepage(intcodepage, libluksde_error_t**error);

       intlibluksde_check_volume_signature(constchar*filename, libluksde_error_t**error);

       intlibluksde_check_volume_signature_wide(constwchar_t*filename, libluksde_error_t**error);

       Available when compiled with libbfio support:

       intlibluksde_check_volume_signature_file_io_handle(libbfio_handle_t*file_io_handle,
           libluksde_error_t**error);

       Notify functions

       voidlibluksde_notify_set_verbose(intverbose);

       intlibluksde_notify_set_stream(FILE*stream, libluksde_error_t**error);

       intlibluksde_notify_stream_open(constchar*filename, libluksde_error_t**error);

       intlibluksde_notify_stream_close(libluksde_error_t**error);

       Error functions

       voidlibluksde_error_free(libluksde_error_t**error);

       intlibluksde_error_fprint(libluksde_error_t*error, FILE*stream);

       intlibluksde_error_sprint(libluksde_error_t*error, char*string, size_tsize);

       intlibluksde_error_backtrace_fprint(libluksde_error_t*error, FILE*stream);

       intlibluksde_error_backtrace_sprint(libluksde_error_t*error, char*string, size_tsize);

       Volume functions

       intlibluksde_volume_initialize(libluksde_volume_t**volume, libluksde_error_t**error);

       intlibluksde_volume_free(libluksde_volume_t**volume, libluksde_error_t**error);

       intlibluksde_volume_signal_abort(libluksde_volume_t*volume, libluksde_error_t**error);

       intlibluksde_volume_open(libluksde_volume_t*volume,   constchar*filename,    intaccess_flags,
           libluksde_error_t**error);

       intlibluksde_volume_close(libluksde_volume_t*volume, libluksde_error_t**error);

       intlibluksde_volume_is_locked(libluksde_volume_t*volume, libluksde_error_t**error);

       intlibluksde_volume_unlock(libluksde_volume_t*volume, libluksde_error_t**error);

       ssize_tlibluksde_volume_read_buffer(libluksde_volume_t*volume,    void*buffer,    size_tbuffer_size,
           libluksde_error_t**error);

       ssize_tlibluksde_volume_read_buffer_at_offset(libluksde_volume_t*volume,  void*buffer,  size_tbuffer_size,
           off64_toffset, libluksde_error_t**error);

       off64_tlibluksde_volume_seek_offset(libluksde_volume_t*volume,     off64_toffset,     intwhence,
           libluksde_error_t**error);

       intlibluksde_volume_get_offset(libluksde_volume_t*volume, off64_t*offset, libluksde_error_t**error);

       intlibluksde_volume_get_size(libluksde_volume_t*volume, size64_t*size, libluksde_error_t**error);

       intlibluksde_volume_get_encryption_method(libluksde_volume_t*volume,      int*encryption_method,
           int*encryption_chaining_mode, libluksde_error_t**error);

       intlibluksde_volume_get_volume_identifier(libluksde_volume_t*volume,       uint8_t*uuid_data,
           size_tuuid_data_size, libluksde_error_t**error);

       intlibluksde_volume_set_key(libluksde_volume_t*volume, constuint8_t*master_key,  size_tmaster_key_size,
           libluksde_error_t**error);

       intlibluksde_volume_set_utf8_password(libluksde_volume_t*volume,     constuint8_t*utf8_string,
           size_tutf8_string_length, libluksde_error_t**error);

       intlibluksde_volume_set_utf16_password(libluksde_volume_t*volume,    constuint16_t*utf16_string,
           size_tutf16_string_length, libluksde_error_t**error);

       Available when compiled with wide character string support:

       intlibluksde_volume_open_wide(libluksde_volume_t*volume,   constwchar_t*filename,  intaccess_flags,
           libluksde_error_t**error);

       Available when compiled with libbfio support:

       intlibluksde_volume_open_file_io_handle(libluksde_volume_t*volume,   libbfio_handle_t*file_io_handle,
           intaccess_flags, libluksde_error_t**error);