-
Notifications
You must be signed in to change notification settings - Fork 76
/
libewf.h.in
2733 lines (2426 loc) · 84 KB
/
libewf.h.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Library to access the Expert Witness Compression Format (EWF)
*
* Copyright (C) 2006-2024, Joachim Metz <joachim.metz@gmail.com>
*
* Refer to AUTHORS for acknowledgements.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#if !defined( _LIBEWF_H )
#define _LIBEWF_H
#include <libewf/codepage.h>
#include <libewf/definitions.h>
#include <libewf/error.h>
#include <libewf/extern.h>
#include <libewf/features.h>
#include <libewf/types.h>
#include <stdio.h>
#if defined( LIBEWF_HAVE_BFIO )
#include <libbfio.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* -------------------------------------------------------------------------
* Support functions
* ------------------------------------------------------------------------- */
/* Returns the library version
*/
LIBEWF_EXTERN \
const char *libewf_get_version(
void );
/* Returns the access flags for reading
*/
LIBEWF_EXTERN \
int libewf_get_access_flags_read(
void );
/* Returns the access flags for reading and writing
*/
LIBEWF_EXTERN \
int libewf_get_access_flags_read_write(
void );
/* Returns the access flags for writing
*/
LIBEWF_EXTERN \
int libewf_get_access_flags_write(
void );
/* Returns the access flags for resume writing
*/
LIBEWF_EXTERN \
int libewf_get_access_flags_write_resume(
void );
/* Retrieves the narrow system string codepage
* A value of 0 represents no codepage, UTF-8 encoding is used instead
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_get_codepage(
int *codepage,
libewf_error_t **error );
/* Sets the narrow system string codepage
* A value of 0 represents no codepage, UTF-8 encoding is used instead
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_set_codepage(
int codepage,
libewf_error_t **error );
/* Determines if a file contains an EWF file signature
* Returns 1 if true, 0 if not or -1 on error
*/
LIBEWF_EXTERN \
int libewf_check_file_signature(
const char *filename,
libewf_error_t **error );
#if defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE )
/* Determines if a file contains an EWF file signature
* Returns 1 if true, 0 if not or -1 on error
*/
LIBEWF_EXTERN \
int libewf_check_file_signature_wide(
const wchar_t *filename,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE ) */
#if defined( LIBEWF_HAVE_BFIO )
/* Determines if a file contains an EWF file signature using a Basic File IO (bfio) handle
* Returns 1 if true, 0 if not or -1 on error
*/
LIBEWF_EXTERN \
int libewf_check_file_signature_file_io_handle(
libbfio_handle_t *file_io_handle,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_BFIO ) */
/* Globs the segment files according to the EWF naming schema
* Make sure the value filenames is referencing, is set to NULL
*
* If the format is known the filename should contain the base of the filename
* otherwise the function will try to determine the format based on the extension
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_glob(
const char *filename,
size_t filename_length,
uint8_t format,
char **filenames[],
int *number_of_filenames,
libewf_error_t **error );
/* Frees globbed filenames
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_glob_free(
char *filenames[],
int number_of_filenames,
libewf_error_t **error );
#if defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE )
/* Globs the segment files according to the EWF naming schema
* Make sure the value filenames is referencing, is set to NULL
*
* If the format is known the filename should contain the base of the filename
* otherwise the function will try to determine the format based on the extension
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_glob_wide(
const wchar_t *filename,
size_t filename_length,
uint8_t format,
wchar_t **filenames[],
int *number_of_filenames,
libewf_error_t **error );
/* Frees globbed wide filenames
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_glob_wide_free(
wchar_t *filenames[],
int number_of_filenames,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE ) */
/* -------------------------------------------------------------------------
* Notify functions
* ------------------------------------------------------------------------- */
/* Sets the verbose notification
*/
LIBEWF_EXTERN \
void libewf_notify_set_verbose(
int verbose );
/* Sets the notification stream
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_notify_set_stream(
FILE *stream,
libewf_error_t **error );
/* Opens the notification stream using a filename
* The stream is opened in append mode
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_notify_stream_open(
const char *filename,
libewf_error_t **error );
/* Closes the notification stream if opened using a filename
* Returns 0 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_notify_stream_close(
libewf_error_t **error );
/* -------------------------------------------------------------------------
* Error functions
* ------------------------------------------------------------------------- */
/* Frees an error
*/
LIBEWF_EXTERN \
void libewf_error_free(
libewf_error_t **error );
/* Prints a descriptive string of the error to the stream
* Returns the number of printed characters if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_error_fprint(
libewf_error_t *error,
FILE *stream );
/* Prints a descriptive string of the error to the string
* The end-of-string character is not included in the return value
* Returns the number of printed characters if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_error_sprint(
libewf_error_t *error,
char *string,
size_t size );
/* Prints a backtrace of the error to the stream
* Returns the number of printed characters if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_error_backtrace_fprint(
libewf_error_t *error,
FILE *stream );
/* Prints a backtrace of the error to the string
* The end-of-string character is not included in the return value
* Returns the number of printed characters if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_error_backtrace_sprint(
libewf_error_t *error,
char *string,
size_t size );
/* -------------------------------------------------------------------------
* Handle functions
* ------------------------------------------------------------------------- */
/* Creates a handle
* Make sure the value handle is referencing, is set to NULL
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_initialize(
libewf_handle_t **handle,
libewf_error_t **error );
/* Frees a handle
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_free(
libewf_handle_t **handle,
libewf_error_t **error );
/* Clones the handle including elements
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_clone(
libewf_handle_t **destination_handle,
libewf_handle_t *source_handle,
libewf_error_t **error );
/* Signals the handle to abort its current activity
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_signal_abort(
libewf_handle_t *handle,
libewf_error_t **error );
/* Opens a set of EWF file(s)
* For reading files should contain all filenames that make up an EWF image
* For writing files should contain the base of the filename, extentions like .e01 will be automatically added
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_open(
libewf_handle_t *handle,
char * const filenames[],
int number_of_filenames,
int access_flags,
libewf_error_t **error );
#if defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE )
/* Opens a set of EWF file(s)
* For reading files should contain all filenames that make up an EWF image
* For writing files should contain the base of the filename, extentions like .e01 will be automatically added
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_open_wide(
libewf_handle_t *handle,
wchar_t * const filenames[],
int number_of_filenames,
int access_flags,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE ) */
#if defined( LIBEWF_HAVE_BFIO )
/* Opens a set of EWF file(s) using a Basic File IO (bfio) pool
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_open_file_io_pool(
libewf_handle_t *handle,
libbfio_pool_t *file_io_pool,
int access_flags,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_BFIO ) */
/* Closes the EWF handle
* Returns 0 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_close(
libewf_handle_t *handle,
libewf_error_t **error );
/* Reads (media) data at the current offset into a buffer
* Returns the number of bytes read, 0 when no longer data can be read or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_read_buffer(
libewf_handle_t *handle,
void *buffer,
size_t buffer_size,
libewf_error_t **error );
/* Reads (media) data at a specific offset
* Returns the number of bytes read, 0 when no longer data can be read or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_read_buffer_at_offset(
libewf_handle_t *handle,
void *buffer,
size_t buffer_size,
off64_t offset,
libewf_error_t **error );
/* Writes (media) data at the current offset
* the necessary settings of the write values must have been made
* Will initialize write if necessary
* Returns the number of bytes written, 0 when no longer data can be written or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_write_buffer(
libewf_handle_t *handle,
const void *buffer,
size_t buffer_size,
libewf_error_t **error );
/* Writes (media) data at a specific offset,
* the necessary settings of the write values must have been made
* Will initialize write if necessary
* Returns the number of bytes written, 0 when no longer data can be written or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_write_buffer_at_offset(
libewf_handle_t *handle,
const void *buffer,
size_t buffer_size,
off64_t offset,
libewf_error_t **error );
/* Retrieves a (media) data chunk
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_data_chunk(
libewf_handle_t *handle,
libewf_data_chunk_t **data_chunk,
libewf_error_t **error );
/* Reads a (media) data chunk at the current offset
* Returns the number of bytes in the data chunk, 0 when no longer data can be read or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_read_data_chunk(
libewf_handle_t *handle,
libewf_data_chunk_t *data_chunk,
libewf_error_t **error );
/* Writes a (media) data chunk at the current offset
* Returns the number of bytes written, 0 when no longer data can be written or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_write_data_chunk(
libewf_handle_t *handle,
libewf_data_chunk_t *data_chunk,
libewf_error_t **error );
/* Finalizes the write by correcting the EWF the meta data in the segment files
* This function is required after writing from stream
* Returns the number of bytes written or -1 on error
*/
LIBEWF_EXTERN \
ssize_t libewf_handle_write_finalize(
libewf_handle_t *handle,
libewf_error_t **error );
/* Seeks a certain offset of the (media) data
* Returns the offset if seek is successful or -1 on error
*/
LIBEWF_EXTERN \
off64_t libewf_handle_seek_offset(
libewf_handle_t *handle,
off64_t offset,
int whence,
libewf_error_t **error );
/* Retrieves the current offset of the (media) data
* Returns the offset if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_offset(
libewf_handle_t *handle,
off64_t *offset,
libewf_error_t **error );
/* Sets the maximum number of (concurrent) open file handles
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_maximum_number_of_open_handles(
libewf_handle_t *handle,
int maximum_number_of_open_handles,
libewf_error_t **error );
/* Retrieves the segment filename size
* The filename size includes the end of string character
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_filename_size(
libewf_handle_t *handle,
size_t *filename_size,
libewf_error_t **error );
/* Retrieves the segment filename
* The filename size should include the end of string character
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_filename(
libewf_handle_t *handle,
char *filename,
size_t filename_size,
libewf_error_t **error );
/* Sets the segment filename
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_segment_filename(
libewf_handle_t *handle,
const char *filename,
size_t filename_length,
libewf_error_t **error );
#if defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE )
/* Retrieves the segment filename size
* The filename size includes the end of string character
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_filename_size_wide(
libewf_handle_t *handle,
size_t *filename_size,
libewf_error_t **error );
/* Retrieves the segment filename
* The filename size should include the end of string character
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_filename_wide(
libewf_handle_t *handle,
wchar_t *filename,
size_t filename_size,
libewf_error_t **error );
/* Sets the segment filename
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_segment_filename_wide(
libewf_handle_t *handle,
const wchar_t *filename,
size_t filename_length,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE ) */
/* Retrieves the maximum segment file size
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_maximum_segment_size(
libewf_handle_t *handle,
size64_t *maximum_segment_size,
libewf_error_t **error );
/* Sets the maximum segment file size
* A maximum segment file size of 0 represents the maximum possible size for the format
* If the maximum segment file size is smaller than the size needed to store a single chunk
* the size off the latter is enforced and not the maximum segment file size
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_maximum_segment_size(
libewf_handle_t *handle,
size64_t maximum_segment_size,
libewf_error_t **error );
/* Determine if the segment files are corrupted
* Returns 1 if corrupted, 0 if not or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_segment_files_corrupted(
libewf_handle_t *handle,
libewf_error_t **error );
/* Determine if the segment files are encrypted
* Returns 1 if encrypted, 0 if not or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_segment_files_encrypted(
libewf_handle_t *handle,
libewf_error_t **error );
/* Retrieves the filename size of the segment file of the current chunk
* The filename size includes the end of string character
* Returns 1 if successful, 0 if no such filename or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_filename_size(
libewf_handle_t *handle,
size_t *filename_size,
libewf_error_t **error );
/* Retrieves the filename of the segment file of the current chunk
* The filename size should include the end of string character
* Returns 1 if successful, 0 if no such filename or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_filename(
libewf_handle_t *handle,
char *filename,
size_t filename_size,
libewf_error_t **error );
#if defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE )
/* Retrieves the filename size of the segment file of the current chunk
* The filename size includes the end of string character
* Returns 1 if successful, 0 if no such filename or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_filename_size_wide(
libewf_handle_t *handle,
size_t *filename_size,
libewf_error_t **error );
/* Retrieves the filename of the segment file of the current chunk
* The filename size should include the end of string character
* Returns 1 if successful, 0 if no such filename or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_filename_wide(
libewf_handle_t *handle,
wchar_t *filename,
size_t filename_size,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_WIDE_CHARACTER_TYPE ) */
#if defined( LIBEWF_HAVE_BFIO )
/* Retrieves the file IO handle of the segment file of the current chunk
* Returns 1 if successful, 0 if no such file IO handle or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_file_io_handle(
libewf_handle_t *handle,
libbfio_handle_t **file_io_handle,
libewf_error_t **error );
#endif /* defined( LIBEWF_HAVE_BFIO ) */
/* -------------------------------------------------------------------------
* Meta data functions
* ------------------------------------------------------------------------- */
/* Retrieves the number of sectors per chunk
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_sectors_per_chunk(
libewf_handle_t *handle,
uint32_t *sectors_per_chunk,
libewf_error_t **error );
/* Sets the number of sectors per chunk
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_sectors_per_chunk(
libewf_handle_t *handle,
uint32_t sectors_per_chunk,
libewf_error_t **error );
/* Retrieves the number of bytes per sector
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_bytes_per_sector(
libewf_handle_t *handle,
uint32_t *bytes_per_sector,
libewf_error_t **error );
/* Sets the number of bytes per sector
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_bytes_per_sector(
libewf_handle_t *handle,
uint32_t bytes_per_sector,
libewf_error_t **error );
/* Retrieves the number of sectors
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_number_of_sectors(
libewf_handle_t *handle,
uint64_t *number_of_sectors,
libewf_error_t **error );
/* Retrieves the chunk size
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_chunk_size(
libewf_handle_t *handle,
size32_t *chunk_size,
libewf_error_t **error );
/* Retrieves the error granularity
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_error_granularity(
libewf_handle_t *handle,
uint32_t *error_granularity,
libewf_error_t **error );
/* Sets the error granularity
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_error_granularity(
libewf_handle_t *handle,
uint32_t error_granularity,
libewf_error_t **error );
/* Retrieves the compression method
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_compression_method(
libewf_handle_t *handle,
uint16_t *compression_method,
libewf_error_t **error );
/* Sets the compression method
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_compression_method(
libewf_handle_t *handle,
uint16_t compression_method,
libewf_error_t **error );
/* Retrieves the compression values
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_compression_values(
libewf_handle_t *handle,
int8_t *compression_level,
uint8_t *compression_flags,
libewf_error_t **error );
/* Sets the compression values
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_compression_values(
libewf_handle_t *handle,
int8_t compression_level,
uint8_t compression_flags,
libewf_error_t **error );
/* Retrieves the size of the contained (media) data
* This function will compensate for a media_size that is not a multitude of bytes_per_sector
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_media_size(
libewf_handle_t *handle,
size64_t *media_size,
libewf_error_t **error );
/* Sets the media size
* The media_size is stored as number_of_sectors x bytes_per_sector
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_media_size(
libewf_handle_t *handle,
size64_t media_size,
libewf_error_t **error );
/* Retrieves the media type value
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_media_type(
libewf_handle_t *handle,
uint8_t *media_type,
libewf_error_t **error );
/* Sets the media type
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_media_type(
libewf_handle_t *handle,
uint8_t media_type,
libewf_error_t **error );
/* Retrieves the media flags
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_media_flags(
libewf_handle_t *handle,
uint8_t *media_flags,
libewf_error_t **error );
/* Sets the media flags
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_media_flags(
libewf_handle_t *handle,
uint8_t media_flags,
libewf_error_t **error );
/* Retrieves the format type value
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_format(
libewf_handle_t *handle,
uint8_t *format,
libewf_error_t **error );
/* Sets the output format
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_format(
libewf_handle_t *handle,
uint8_t format,
libewf_error_t **error );
/* Retrieves the segment file version
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_file_version(
libewf_handle_t *handle,
uint8_t *major_version,
uint8_t *minor_version,
libewf_error_t **error );
/* Retrieves the segment file set identifier
* The identifier is a GUID and is 16 bytes of size
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_segment_file_set_identifier(
libewf_handle_t *handle,
uint8_t *set_identifier,
size_t size,
libewf_error_t **error );
/* Sets the segment file set identifier
* The identifier is a GUID and is 16 bytes of size
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_segment_file_set_identifier(
libewf_handle_t *handle,
const uint8_t *set_identifier,
size_t size,
libewf_error_t **error );
/* Retrieves the MD5 hash
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_md5_hash(
libewf_handle_t *handle,
uint8_t *md5_hash,
size_t size,
libewf_error_t **error );
/* Sets the MD5 hash
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_md5_hash(
libewf_handle_t *handle,
const uint8_t *md5_hash,
size_t size,
libewf_error_t **error );
/* Retrieves the SHA1 hash
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_sha1_hash(
libewf_handle_t *handle,
uint8_t *sha1_hash,
size_t size,
libewf_error_t **error );
/* Sets the SHA1 hash
* Returns 1 if successful, 0 if not set or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_sha1_hash(
libewf_handle_t *handle,
const uint8_t *sha1_hash,
size_t size,
libewf_error_t **error );
/* Retrieves the number of chunks written
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_number_of_chunks_written(
libewf_handle_t *handle,
uint32_t *number_of_chunks,
libewf_error_t **error );
/* Sets the read zero chunk on error
* The chunk is not zeroed if read raw is used
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_set_read_zero_chunk_on_error(
libewf_handle_t *handle,
uint8_t zero_on_error,
libewf_error_t **error );
/* Copies the media values from the source to the destination handle
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_copy_media_values(
libewf_handle_t *destination_handle,
libewf_handle_t *source_handle,
libewf_error_t **error );
/* Retrieves the number of acquiry errors
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_number_of_acquiry_errors(
libewf_handle_t *handle,
uint32_t *number_of_errors,
libewf_error_t **error );
/* Retrieves an acquiry error
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_acquiry_error(
libewf_handle_t *handle,
uint32_t index,
uint64_t *start_sector,
uint64_t *number_of_sectors,
libewf_error_t **error );
/* Appends an acquiry error
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_append_acquiry_error(
libewf_handle_t *handle,
uint64_t start_sector,
uint64_t number_of_sectors,
libewf_error_t **error );
/* Retrieves the number of checksum errors
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_number_of_checksum_errors(
libewf_handle_t *handle,
uint32_t *number_of_errors,
libewf_error_t **error );
/* Retrieves a checksum error
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_checksum_error(
libewf_handle_t *handle,
uint32_t error_index,
uint64_t *start_sector,
uint64_t *number_of_sectors,
libewf_error_t **error );
/* Appends a checksum error
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_append_checksum_error(
libewf_handle_t *handle,
uint64_t start_sector,
uint64_t number_of_sectors,
libewf_error_t **error );
/* Retrieves the number of sessions
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_number_of_sessions(
libewf_handle_t *handle,
uint32_t *number_of_sessions,
libewf_error_t **error );
/* Retrieves a session
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_get_session(
libewf_handle_t *handle,
uint32_t index,
uint64_t *start_sector,
uint64_t *number_of_sectors,
libewf_error_t **error );
/* Appends a session
* Returns 1 if successful or -1 on error
*/
LIBEWF_EXTERN \
int libewf_handle_append_session(
libewf_handle_t *handle,
uint64_t start_sector,
uint64_t number_of_sectors,
libewf_error_t **error );
/* Retrieves the number of tracks