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
|
# pylint: disable=protected-access
from os import devnull
from pathlib import Path
import pytest
from fpdf import FPDF
from fpdf.encryption import StandardSecurityHandler as sh
from fpdf.enums import AccessPermission, EncryptionMethod
from fpdf.errors import FPDFException
from test.conftest import assert_pdf_equal
HERE = Path(__file__).resolve().parent
XMP_METADATA = """<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="fpdf2">
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description rdf:about="">
<dc:title xmlns:dc="http://purl.org/dc/elements/1.1/">
<rdf:Alt>
<rdf:li xml:lang="x-default">My document title</rdf:li>
</rdf:Alt>
</dc:title>
</rdf:Description>
<rdf:Description rdf:about="">
<dc:description xmlns:dc="http://purl.org/dc/elements/1.1/">
<rdf:Alt>
<rdf:li xml:lang="x-default">This is a test document for fpdf2 with XMP metadata</rdf:li>
</rdf:Alt>
</dc:description>
</rdf:Description>
<rdf:Description rdf:about="">
<dc:creator xmlns:dc="http://purl.org/dc/elements/1.1/">
<rdf:Seq>
<rdf:li>Lucas Cimon</rdf:li>
</rdf:Seq>
</dc:creator>
</rdf:Description>
<rdf:Description xmlns:pdf="http://ns.adobe.com/pdf/1.3/" rdf:about="" pdf:Keywords="test data pdf fpdf2"/>
<rdf:Description xmlns:pdf="http://ns.adobe.com/pdf/1.3/" rdf:about="" pdf:Producer="py-pdf/fpdf2.X.Y"/>
<rdf:Description xmlns:xmp="http://ns.adobe.com/xap/1.0/" rdf:about="" xmp:CreatorTool="fpdf2"/>
</rdf:RDF>
</x:xmpmeta>"""
def test_encryption_rc4(tmp_path):
pdf = FPDF()
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(owner_password="fpdf2", permissions=AccessPermission.all())
assert_pdf_equal(pdf, HERE / "encryption_rc4.pdf", tmp_path)
def test_encryption_rc4_permissions(tmp_path):
pdf = FPDF()
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
permissions=AccessPermission.PRINT_LOW_RES | AccessPermission.PRINT_HIGH_RES,
)
assert_pdf_equal(pdf, HERE / "encryption_rc4_permissions.pdf", tmp_path)
def test_no_encryption(tmp_path):
pdf = FPDF()
def custom_file_id():
return pdf._default_file_id(bytearray([0xFF]))
pdf.file_id = custom_file_id
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
encryption_method=EncryptionMethod.NO_ENCRYPTION,
permissions=AccessPermission.none(),
)
assert_pdf_equal(pdf, HERE / "no_encryption.pdf", tmp_path)
def test_encryption_empty_user_password(tmp_path):
pdf = FPDF()
pdf.set_encryption(owner_password="fpdf2", user_password="")
assert_pdf_equal(pdf, HERE / "encryption_empty_user_password.pdf", tmp_path)
def test_encryption_rc4_user_password(tmp_path):
pdf = FPDF()
def custom_file_id():
return pdf._default_file_id(bytearray([0xFF]))
pdf.file_id = custom_file_id
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
user_password="654321",
permissions=AccessPermission.PRINT_LOW_RES | AccessPermission.PRINT_HIGH_RES,
)
assert_pdf_equal(pdf, HERE / "encryption_rc4_user_password.pdf", tmp_path)
def test_encryption_aes128(tmp_path):
pdf = FPDF()
def custom_file_id():
return pdf._default_file_id(bytearray([0xFF]))
pdf.file_id = custom_file_id
def fixed_iv(size):
return bytearray(size)
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
encryption_method=EncryptionMethod.AES_128,
permissions=AccessPermission.none(),
)
pdf._security_handler.get_random_bytes = fixed_iv
assert_pdf_equal(pdf, HERE / "encryption_aes128.pdf", tmp_path)
def test_encrypt_metadata(tmp_path):
pdf = FPDF()
def custom_file_id():
# return pdf._default_file_id(bytearray([0xFF]))
return "<AC2718D5DA802D34E7F97EEF0A0B52C5><AC2718D5DA802D34E7F97EEF0A0B52C5>"
pdf.file_id = custom_file_id
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
encrypt_metadata=True,
)
pdf.set_xmp_metadata(XMP_METADATA)
assert_pdf_equal(pdf, HERE / "encrypt_metadata.pdf", tmp_path)
@pytest.mark.skip(reason="Font related tests are failing with the fonts available in Debian")
def test_encrypt_font(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.add_font(
"Quicksand", style="", fname=HERE.parent / "fonts" / "Quicksand-Regular.otf"
)
pdf.add_font(
"Quicksand", style="B", fname=HERE.parent / "fonts" / "Quicksand-Bold.otf"
)
pdf.add_font(
"Quicksand", style="I", fname=HERE.parent / "fonts" / "Quicksand-Italic.otf"
)
pdf.set_font("Quicksand", size=32)
text = (
"Lorem ipsum dolor, **consectetur adipiscing** elit,"
" eiusmod __tempor incididunt__ ut labore et dolore --magna aliqua--."
)
pdf.multi_cell(w=pdf.epw, text=text, markdown=True)
pdf.ln()
pdf.multi_cell(w=pdf.epw, text=text, markdown=True, align="L")
pdf.set_encryption(owner_password="fpdf2")
assert_pdf_equal(pdf, HERE / "encrypt_fonts.pdf", tmp_path)
def test_encryption_with_hyperlink(tmp_path): # issue 672
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica")
pdf.cell(text="hyperlink", link="https://github.com/py-pdf/fpdf2")
pdf.set_encryption(owner_password="fpdf2")
assert_pdf_equal(pdf, HERE / "encryption_with_hyperlink.pdf", tmp_path)
def test_encrypt_outline(tmp_path): # issue 732
pdf = FPDF()
pdf.add_page()
pdf.set_font("helvetica")
pdf.start_section("Title")
pdf.start_section("Subtitle", level=1)
pdf.set_encryption(owner_password="fpdf2")
assert_pdf_equal(pdf, HERE / "encrypt_outline.pdf", tmp_path)
def test_encryption_aes256(tmp_path):
pdf = FPDF()
def custom_file_id():
return pdf._default_file_id(bytearray([0xFF]))
pdf.file_id = custom_file_id
def fixed_iv(size):
return bytearray(size)
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.text(50, 50, "Some text")
pdf.ink_annotation(
[(40, 50), (70, 25), (100, 50), (70, 75), (40, 50)],
title="Lucas",
text="Some encrypted annotation",
)
pdf.set_encryption(
owner_password="fpdf2",
encryption_method=EncryptionMethod.AES_256,
permissions=AccessPermission.none(),
)
pdf._security_handler.get_random_bytes = fixed_iv
assert_pdf_equal(pdf, HERE / "encryption_aes256.pdf", tmp_path)
def test_encryption_aes256_with_user_password(tmp_path):
pdf = FPDF()
def custom_file_id():
return pdf._default_file_id(bytearray([0xFF]))
pdf.file_id = custom_file_id
def fixed_iv(size):
return bytearray(size)
pdf.set_author("author")
pdf.set_subject("string to be encrypted")
pdf.add_page()
pdf.set_font("helvetica", size=12)
pdf.cell(text="hello world")
pdf.set_encryption(
owner_password="fpdf2",
user_password="1" * 1000,
encryption_method=EncryptionMethod.AES_256,
permissions=AccessPermission.all(),
)
pdf._security_handler.get_random_bytes = fixed_iv
assert_pdf_equal(pdf, HERE / "encryption_aes256_user_password.pdf", tmp_path)
def test_blank_owner_password():
pdf = FPDF()
pdf.set_encryption(
owner_password="",
encryption_method=EncryptionMethod.AES_256,
permissions=AccessPermission.none(),
)
with pytest.raises(FPDFException) as e:
pdf.output(devnull)
assert str(e.value) == "Invalid owner password "
def test_password_prep():
"""
The PDF standard requires the passwords to be prepared using the stringprep algorithm
using the SASLprep as per RFC 4013
https://datatracker.ietf.org/doc/html/rfc4013
Those assertions are bases on the examples section of the RFC
"""
assert sh.prepare_string("I\xadX") == b"IX" # SOFT HYPHEN mapped to nothing
assert sh.prepare_string("user") == b"user" # no transformation
assert sh.prepare_string("USER") == b"USER" # case preserved
assert sh.prepare_string("\xaa") == b"a" # output is NFKC, input in ISO 8859-1
assert sh.prepare_string("\u2168") == b"IX" # output is NFKC, will match #1
with pytest.raises(FPDFException) as e:
sh.prepare_string("\x07") # Error - prohibited character
assert str(e.value) == "The password contains prohibited characters"
with pytest.raises(FPDFException) as e:
sh.prepare_string("\u0627\x31") # Error - bidirectional check
assert sh.prepare_string("A" * 300) == b"A" * 127 # test cap 127 chars
@pytest.mark.skip(reason="Font related tests are failing with the fonts available in Debian")
def test_encryption_unicode(tmp_path):
"Issue #933"
pdf = FPDF()
pdf.set_author("Thai")
pdf.set_subject("ทดสอบภาษาไทย")
pdf.add_page()
pdf.set_text_shaping()
pdf.add_font("Garuda", fname=HERE.parent / "fonts" / "Garuda.ttf")
pdf.set_font("Garuda", size=12)
pdf.start_section("ทดสอบภาษาไทย")
pdf.cell(
text="สวัสดี ทดสอบภาษาไทย กีกี้ กาก้า ก๋า อ้า อ้ำ ฤาษี ทุ่มทุน อุ้งอุ๋ง น้ำใจ ฯลฯ ญาญ่า ฐาน ฎีกา ฏฒัฯนณ ภัทร์ สิทธิ์"
)
pdf.set_encryption(owner_password="fpdf2")
assert_pdf_equal(pdf, HERE / "encryption_unicode.pdf", tmp_path)
|