harumi 1.3.0

Pure-Rust PDF — CJK font embedding (Chinese/Japanese/Korean), OCR text overlay, text extraction, HTML→PDF, page merge/split. WASM-ready, zero C deps.
Documentation 
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

mod helpers;

use harumi::{Document, Error};

// ---------------------------------------------------------------------------
// Fixture builder
//
// Creates a minimal encrypted PDF in memory using harumi's re-exported lopdf.
// No external binary or fixture file needed — the doc is generated at test time.
// ---------------------------------------------------------------------------

fn make_encrypted_pdf(user_pw: &str, owner_pw: &str) -> Vec<u8> {
    use harumi::lopdf::{EncryptionState, EncryptionVersion, Object, Permissions, StringFormat};

    // Start with a harumi-generated plain PDF (correct structure guaranteed).
    let plain = {
        let mut doc = Document::new((595.0, 842.0)).unwrap();
        doc.save_to_bytes().unwrap()
    };

    // Load with lopdf, apply encryption, export.
    let mut inner = harumi::lopdf::Document::load_from(plain.as_slice())
        .expect("lopdf must load harumi-generated PDF");

    // PDF encryption requires a /ID array in the trailer; harumi's blank PDFs
    // don't include one by default, so we add a static placeholder here.
    let id_bytes = b"\x01\x23\x45\x67\x89\xab\xcd\xef\x01\x23\x45\x67\x89\xab\xcd\xef".to_vec();
    let id_obj = Object::Array(vec![
        Object::String(id_bytes.clone(), StringFormat::Hexadecimal),
        Object::String(id_bytes, StringFormat::Hexadecimal),
    ]);
    inner.trailer.set("ID", id_obj);

    let version = EncryptionVersion::V2 {
        document: &inner,
        owner_password: owner_pw,
        user_password: user_pw,
        key_length: 40,
        permissions: Permissions::all(),
    };
    let state =
        EncryptionState::try_from(version).expect("EncryptionState::try_from must not fail");
    inner.encrypt(&state).expect("encrypt must succeed");

    let mut buf = Vec::new();
    inner.save_to(&mut buf).expect("save_to must succeed");
    buf
}

// ---------------------------------------------------------------------------
// from_bytes_with_password
// ---------------------------------------------------------------------------

#[test]
fn bytes_correct_user_password_loads() {
    let pdf = make_encrypted_pdf("secret", "owner123");
    let doc = Document::from_bytes_with_password(&pdf, "secret").unwrap();
    assert_eq!(doc.page_count(), 1);
}

#[test]
fn bytes_correct_owner_password_loads() {
    let pdf = make_encrypted_pdf("secret", "owner123");
    let doc = Document::from_bytes_with_password(&pdf, "owner123").unwrap();
    assert_eq!(doc.page_count(), 1);
}

#[test]
fn bytes_wrong_password_returns_wrong_password_error() {
    let pdf = make_encrypted_pdf("secret", "owner123");
    match Document::from_bytes_with_password(&pdf, "wrong") {
        Err(Error::WrongPassword) => {}
        Ok(_) => panic!("expected WrongPassword but got Ok"),
        Err(e) => panic!("expected WrongPassword, got {e:?}"),
    }
}

#[test]
fn bytes_empty_password_on_pw_protected_doc_returns_wrong_password() {
    let pdf = make_encrypted_pdf("secret", "owner123");
    // Empty password should fail because user_pw is non-empty.
    // lopdf tries empty password first; here it won't match.
    match Document::from_bytes_with_password(&pdf, "") {
        Err(Error::WrongPassword) => {}
        Ok(_) => panic!("expected WrongPassword but got Ok"),
        Err(e) => panic!("expected WrongPassword, got {e:?}"),
    }
}

// ---------------------------------------------------------------------------
// from_file_with_password
// ---------------------------------------------------------------------------

#[test]
fn file_correct_password_loads() {
    let pdf = make_encrypted_pdf("filetest", "fileowner");
    let path = std::env::temp_dir().join("harumi_enc_test_correct.pdf");
    std::fs::write(&path, &pdf).unwrap();

    let result = Document::from_file_with_password(&path, "filetest");
    let _ = std::fs::remove_file(&path);

    let doc = result.unwrap();
    assert_eq!(doc.page_count(), 1);
}

#[test]
fn file_wrong_password_returns_wrong_password_error() {
    let pdf = make_encrypted_pdf("filetest", "fileowner");
    let path = std::env::temp_dir().join("harumi_enc_test_wrong.pdf");
    std::fs::write(&path, &pdf).unwrap();

    let result = Document::from_file_with_password(&path, "bad");
    let _ = std::fs::remove_file(&path);

    assert!(matches!(result, Err(Error::WrongPassword)));
}

#[test]
fn file_nonexistent_path_returns_io_error() {
    let result = Document::from_file_with_password("/nonexistent/path/test.pdf", "pw");
    assert!(matches!(result, Err(Error::Io(_))));
}

// ---------------------------------------------------------------------------
// is_encrypted
// ---------------------------------------------------------------------------

#[test]
fn is_encrypted_true_after_password_load() {
    let pdf = make_encrypted_pdf("pw", "ow");
    let doc = Document::from_bytes_with_password(&pdf, "pw").unwrap();
    assert!(
        doc.is_encrypted(),
        "is_encrypted() must be true for a document loaded with a password"
    );
}

#[test]
fn is_encrypted_false_for_blank_new_document() {
    let doc = Document::new((595.0, 842.0)).unwrap();
    assert!(!doc.is_encrypted());
}

#[test]
fn is_encrypted_false_for_plain_from_bytes() {
    let pdf = helpers::minimal_pdf_bytes();
    let doc = Document::from_bytes(&pdf).unwrap();
    assert!(!doc.is_encrypted());
}

// ---------------------------------------------------------------------------
// Operations on decrypted documents
// ---------------------------------------------------------------------------

#[test]
fn decrypted_doc_page_ops_work() {
    let pdf = make_encrypted_pdf("ops", "opsowner");
    let mut doc = Document::from_bytes_with_password(&pdf, "ops").unwrap();

    // Page access
    assert_eq!(doc.page_count(), 1);
    let (w, h) = doc.page(1).unwrap().size().unwrap();
    assert!((w - 595.0).abs() < 1.0);
    assert!((h - 842.0).abs() < 1.0);

    // Can insert a blank page
    doc.insert_blank_page(1, (595.0, 842.0)).unwrap();
    assert_eq!(doc.page_count(), 2);
}

#[test]
fn decrypted_doc_can_embed_font_and_save() {
    let font_bytes = std::fs::read("tests/fixtures/NotoSansJP-Regular.ttf")
        .expect("NotoSansJP fixture must exist");

    let pdf = make_encrypted_pdf("fontsave", "fsowner");
    let mut doc = Document::from_bytes_with_password(&pdf, "fontsave").unwrap();
    let font = doc.embed_font(&font_bytes).unwrap();
    doc.page(1)
        .unwrap()
        .add_invisible_text("テスト", font, [72.0, 700.0], 12.0)
        .unwrap();

    let out = doc.save_to_bytes().unwrap();
    // The saved PDF must be valid and readable (no password needed — we don't re-encrypt).
    let reloaded = Document::from_bytes(&out).unwrap();
    assert_eq!(reloaded.page_count(), 1);
}

// ---------------------------------------------------------------------------
// Consistency: loading plain vs encrypted round-trip
// ---------------------------------------------------------------------------

#[test]
fn password_roundtrip_page_count_matches_plain() {
    // Plain
    let mut plain_doc = Document::new((595.0, 842.0)).unwrap();
    plain_doc.insert_blank_page(1, (595.0, 842.0)).unwrap(); // 2 pages
    let plain_bytes = plain_doc.save_to_bytes().unwrap();
    let plain_count = Document::from_bytes(&plain_bytes).unwrap().page_count();

    // Encrypt that same PDF
    let mut inner = harumi::lopdf::Document::load_from(plain_bytes.as_slice()).unwrap();
    use harumi::lopdf::{EncryptionState, EncryptionVersion, Object, Permissions, StringFormat};
    let id_b = b"\x01\x23\x45\x67\x89\xab\xcd\xef\x01\x23\x45\x67\x89\xab\xcd\xef".to_vec();
    inner.trailer.set(
        "ID",
        Object::Array(vec![
            Object::String(id_b.clone(), StringFormat::Hexadecimal),
            Object::String(id_b, StringFormat::Hexadecimal),
        ]),
    );
    let ver = EncryptionVersion::V2 {
        document: &inner,
        owner_password: "owner",
        user_password: "user",
        key_length: 40,
        permissions: Permissions::all(),
    };
    inner
        .encrypt(&EncryptionState::try_from(ver).unwrap())
        .unwrap();
    let mut enc_buf = Vec::new();
    inner.save_to(&mut enc_buf).unwrap();

    let enc_count = Document::from_bytes_with_password(&enc_buf, "user")
        .unwrap()
        .page_count();

    assert_eq!(
        plain_count, enc_count,
        "page count must survive encryption round-trip"
    );
}