Python, PyPDF2でPDFのパスワードを設定・解除（暗号化・復号）

Date: 2019-01-14 / tags: Python, PDF

PythonのサードパーティライブラリPyPDF2を使うと、PDFファイルのパスワードの設定や解除（暗号化・復号）ができる。

mstamy2/PyPDF2: A utility to read and write PDFs with Python

既存のPDFファイルにパスワードを設定して保護したり、パスワード付きの暗号化されたPDFファイルをパスワードなしのPDFファイルとして保存したりすることが可能。

あくまでも既知のパスワードを使って解除するだけで、パスワードが分からない場合は解除できない（総当たりでパスワードを試すスクリプトを作成することはできる）。また、暗号化アルゴリズムはRC4のみに対応しAESに対応していないため、最近のソフトで暗号化されたファイルは解除できない場合が多い（バージョン1.26.0時点）。

ここでは以下の内容について説明する。

PyPDF2のインストール
PyPDF2によるパスワード処理の制約
PDFファイルが暗号化されているか確認
PDFファイルにパスワードを設定して保存
PDFファイルのパスワードを解除（削除・変更）して保存

サンプルで使用しているPDFファイルは以下のリンクから。暗号化されているファイルのパスワードはすべてpassword。

python-snippets/notebook/data/src/pdf

すべてのPDFファイルに対して動作を保証するものではない。

PyPDF2のインストール

PyPDF2は外部ライブラリに依存していない。pip（pip3）やcondaでインストール可能。

$ pip install PyPDF2

以下のサンプルコードで使用しているPyPDF2のバージョンは1.26.0。

クラスやメソッドなどの詳細は公式ドキュメントを参照。

PyPDF2 Documentation — PyPDF2 1.26.0 documentation

IssueやPull Requestが溜まっており活発に開発されているという状況ではないが、シンプルなPDFファイルの処理であれば問題ない。

mstamy2/PyPDF2: A utility to read and write PDFs with Python

PyPDF2によるパスワード処理の制約

暗号化アルゴリズムによってはパスワードを解除できない

Adobe AcrobatでPDFファイルにパスワードを設定する場合、以下の暗号化アルゴリズム（暗号化レベル）を選択できる。

「Acrobat 6 > .0 およびそれ以降」（PDF 1.5）を選択すると、128-bit RC4 を使用して文書が暗号化されます。
「Acrobat 7.0 およびそれ以降」（PDF 1.6）を選択すると、128-bit キーサイズの AES 暗号化アルゴリズムを使用して文書が暗号化されます。
「Acrobat X およびそれ以降」（PDF 1.7）を選択すると、256-bit AES を使用して文書が暗号化されます。Acrobat 8 および 9 で作成した文書に 256-bit AES 暗号化を適用するには、「Acrobat X およびそれ以降」を選択します。
パスワードによる PDF の保護 - Adobe Acrobat

ソースコードからも分かるように、PyPDF2（バージョン1.26.0時点）で対応している暗号化アルゴリズムはRC4のみ。AESで暗号化されたファイルは復号（パスワード解除）できない。

Pythonのライブラリではないが、コマンドラインでPDFファイルのセキュリティ設定を制御できるものとしてqpdfがある。AESにも対応している。

qpdf/qpdf: Primary QPDF source code and documentation

パスワードを設定し保存する際に時間がかかる場合がある

サイズが大きいファイルにパスワードを設定して保存すると処理時間が長くなる場合がある。例えば、500ページ / 10MB程度の電子書籍にパスワードを設定して保存すると1分強かかった。当然、マシンパワーにも依存するだろうが、大きいサイズのファイルを一括で処理したい場合などは注意。

情報が失われる可能性がある

これはPyPDF2の制約というよりも以下で説明するサンプルコードについての注意点。

以下のサンプルコードではいくつかのファイルで試して画像やレイアウト、メタデータ（作成者やタイトルなど）が保持されていることを確認したが、複雑なセキュリティ設定やAcrobat等の最新機能を駆使した場合にそれらの情報がそのまま保存されるかは未確認。

元のPDFファイルは残しておくことを強く推奨する。

PDFファイルが暗号化されているか確認

PyPDF2のPdfFileReaderクラスのisEncrypted属性で、PDFファイルが暗号化されているかどうかを確認できる。

PdfFileReaderはコンストラクタにPDFファイルのパスを指定して生成する。isEncryptedという名前の通り、暗号されていればTrue、いなければFalseとなる。

import PyPDF2

pdf = PyPDF2.PdfFileReader('data/src/pdf/sample1.pdf')

print(pdf.isEncrypted)
# False

source: pypdf2_password.py

PDFファイルにパスワードを設定して保存

以下のような流れでパスワードなしのPDFファイルにパスワードを設定して保存する。

元のPDFファイルからPdfFileReaderオブジェクトを生成
空のPdfFileWriterオブジェクトを作成
PdfFileReaderオブジェクトの中身をコピー
PdfFileWriterオブジェクトにパスワードを設定
PdfFileWriterオブジェクトをPDFファイルとして保存

PdfFileReaderとPdfFileWriterをそれぞれのコンストラクタから生成。

src_pdf = PyPDF2.PdfFileReader('data/src/pdf/sample1.pdf')

dst_pdf = PyPDF2.PdfFileWriter()

source: pypdf2_password.py

cloneReaderDocumentRoot()でドキュメントの内容をコピー。

dst_pdf.cloneReaderDocumentRoot(src_pdf)

source: pypdf2_password.py

作成者やタイトルなどのメタデータもそのままでパスワードを付与したい場合は、メタデータもコピーする。必要なければ省略してOK。

メタデータはPdfFileReaderオブジェクトのdocumentInfo属性で取得し、PdfFileWriterオブジェクトのaddMetadata()メソッドで追加できる。ファイルによってはdocumentInfo属性で取得した辞書をそのままaddMetadata()メソッドの引数にするとエラーになる（ならないファイルもある）。

print(src_pdf.documentInfo)
# {'/Title': IndirectObject(33, 0), '/Producer': IndirectObject(34, 0), '/Creator': IndirectObject(35, 0), '/CreationDate': IndirectObject(36, 0), '/ModDate': IndirectObject(36, 0)}

# dst_pdf.addMetadata(src_pdf.documentInfo)
# TypeError: createStringObject should have str or unicode arg

source: pypdf2_password.py

もっといい方法があるかもしれないが、ここでは新たな辞書を生成してからaddMetadata()メソッドに渡す。辞書内包表記を使う。

関連記事: Pythonで辞書を作成するdict()と波括弧、辞書内包表記

d = {key: src_pdf.documentInfo[key] for key in src_pdf.documentInfo.keys()}

print(d)
# {'/Title': 'sample1', '/Producer': 'macOS バージョン10.14.2（ビルド18C54） Quartz PDFContext', '/Creator': 'Keynote', '/CreationDate': "D:20190114072947Z00'00'", '/ModDate': "D:20190114072947Z00'00'"}

dst_pdf.addMetadata(d)

source: pypdf2_password.py

メタデータについては以下の記事も参照。

関連記事: Python, PyPDF2でPDFの作成者やタイトルなどを取得・削除・変更

encrypt()メソッドで暗号化。引数にパスワードを指定する。第一引数user_pwdでユーザーパスワード、第二引数owner_pwdでオーナーパスワードを設定可能。第二引数を省略するとオーナーパスワードも第一引数に指定した文字列となる。

The PdfFileWriter Class: encrypt() — PyPDF2 1.26.0 documentation

dst_pdf.encrypt('password')

source: pypdf2_password.py

最後にwrite()メソッドを使用してPdfFileWriterオブジェクトをpdfファイルとして保存する。

write()の引数はパス文字列ではなくファイルオブジェクトである必要があるのでopen()を使う。wbで書き込み用のバイナリファイルとしてオープンする。

関連記事: Pythonでファイルの読み込み、書き込み（作成・追記）

with open('data/temp/sample1_pass.pdf', 'wb') as f:
    dst_pdf.write(f)

source: pypdf2_password.py

まとめて関数化すると以下のようになる。例外処理は省略。

def set_password(src_path, dst_path, password):
    src_pdf = PyPDF2.PdfFileReader(src_path)

    dst_pdf = PyPDF2.PdfFileWriter()
    dst_pdf.cloneReaderDocumentRoot(src_pdf)

    d = {key: src_pdf.documentInfo[key] for key in src_pdf.documentInfo.keys()}
    dst_pdf.addMetadata(d)

    dst_pdf.encrypt(password)

    with open(dst_path, 'wb') as f:
        dst_pdf.write(f)

set_password('data/src/pdf/sample1.pdf', 'data/temp/sample1_pass.pdf', 'password')

source: pypdf2_password.py

出力パスを入力パス（元ファイルのパス）と同じにすると元のPDFファイルが上書きされるが、上述のように、複雑なPDFファイルなどはすべての情報が保持されるか未確認なので、元ファイルは上書きせずに残しておくことを推奨する。

PDFファイルのパスワードを解除（削除・変更）して保存

パスワード付きのPDFファイルのパスワードを削除したり変更したりして保存するのも、上述のパスワードの設定とほぼ同じ流れ。

元のPDFファイルからPdfFileReaderオブジェクトを生成
PdfFileReaderオブジェクトのパスワードを解除
PdfFileWriterオブジェクトを作成
PdfFileReaderオブジェクトの中身をコピー
PdfFileWriterオブジェクトにパスワードを設定
PdfFileWriterオブジェクトをPDFファイルとして保存

パスワードを解除するステップが増えただけ。

暗号化されたPDFファイルから生成したPdfFileReaderオブジェクトではdocumentInfo属性などの情報にアクセスできない。

pdf_rc4 = PyPDF2.PdfFileReader('data/src/pdf/sample1_pass_rc4.pdf')

print(pdf_rc4.isEncrypted)
# True

# print(pdf_rc4.documentInfo)
# PdfReadError: file has not been decrypted

source: pypdf2_password.py

パスワードの解除にはdecrypt()メソッドを使う。パスワードが一致しない場合は0、ユーザーパスワードに一致した場合は1、オーナーパスワードに一致した場合は2を返す。

The PdfFileReader Class: decrypt() — PyPDF2 1.26.0 documentation

解除後はdocumentInfo属性などの情報にアクセスできる。

print(pdf_rc4.decrypt('wrong-password'))
# 0

print(pdf_rc4.decrypt('password'))
# 1

print(pdf_rc4.documentInfo)
# {'/Producer': 'macOS バージョン10.14.2（ビルド18C54） Quartz PDFContext', '/Title': 'sample1', '/Creator': 'Keynote', '/CreationDate': "D:20190114072947Z00'00'", '/ModDate': "D:20190114072947Z00'00'"}

source: pypdf2_password.py

PyPDF2が対応していない暗号化アルゴリズムに対してはNotImplementedError例外が送出される。上述のようにPyPDF2はAESに対応していない（バージョン1.26.0時点）ので、該当のファイルのパスワードは解除できない。

pdf_aes = PyPDF2.PdfFileReader('data/src/pdf/sample1_pass_aes.pdf')

# print(pdf_aes.decrypt('password'))
# NotImplementedError: only algorithm code 1 and 2 are supported

source: pypdf2_password.py

パスワードを解除（削除・変更）して保存する処理を関数化すると以下のようになる。

def change_password(src_path, dst_path, src_password, dst_password=None):
    src_pdf = PyPDF2.PdfFileReader(src_path)
    src_pdf.decrypt(src_password)

    dst_pdf = PyPDF2.PdfFileWriter()
    dst_pdf.cloneReaderDocumentRoot(src_pdf)

    d = {key: src_pdf.documentInfo[key] for key in src_pdf.documentInfo.keys()}
    dst_pdf.addMetadata(d)

    if dst_password:
        dst_pdf.encrypt(dst_password)

    with open(dst_path, 'wb') as f:
        dst_pdf.write(f)

source: pypdf2_password.py

パスワードを削除したい場合は引数dst_passwordを省略すると出力ファイルは暗号化されず、パスワードなしのPDFファイルとなる。パスワードを変更したい場合は引数dst_passwordに新たなパスワードを指定すればOK。

change_password('data/src/pdf/sample1_pass_rc4.pdf', 'data/temp/sample1_no_pass.pdf', 'password')

change_password('data/src/pdf/sample1_pass_rc4.pdf', 'data/temp/sample1_new_pass.pdf',
                'password', 'new_password')

source: pypdf2_password.py

note.nkmk.me

Python, PyPDF2でPDFのパスワードを設定・解除（暗号化・復号）

PyPDF2のインストール

PyPDF2によるパスワード処理の制約

暗号化アルゴリズムによってはパスワードを解除できない

パスワードを設定し保存する際に時間がかかる場合がある

情報が失われる可能性がある

PDFファイルが暗号化されているか確認

PDFファイルにパスワードを設定して保存

PDFファイルのパスワードを解除（削除・変更）して保存

関連カテゴリー

関連記事