Apache PDFBox Decrypt

Apache PDFBox Decrypt

Certified

Remove the password protection of a PDF

Opens an encrypted PDF with its password and stores an unencrypted copy in internal storage, for example before merging or filling it. Fails with a clear message when the password is missing or wrong.

yaml
type: io.kestra.plugin.pdfbox.security.Decrypt

Unlock a protected PDF before extracting its text

yaml
id: pdf_decrypt
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: decrypt
    type: io.kestra.plugin.pdfbox.security.Decrypt
    from: "{{ inputs.file }}"
    password: "{{ secret('PDF_PASSWORD') }}"

  - id: text
    type: io.kestra.plugin.pdfbox.text.Extract
    from: "{{ outputs.decrypt.uri }}"
Properties

The encrypted PDF, as an internal storage URI

Password of the PDF

The owner password is needed to remove the protection of a file that restricts permissions without a user password.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Formaturi

Internal storage URI of the decrypted PDF