PDFCLOUD-5192 Add optional delete step to security samples by datalogics-dliang · Pull Request #104 · pdfrest/pdfrest-api-samples

datalogics-dliang · 2025-09-02T20:22:04Z

Adds an optional delete step to security samples, e.g. samples for redaction, watermarking, encrypting, or restricting.
- cURL is fully completed, and
- 7 selected samples in the other languages (DotNet, Java, JavaScript, Python, PHP) have been selected to be edited.
There are a remaining 95 samples (complex, JSON Payload, and Multipart Payload) that have not yet been edited, but this work has been paused to wait for a testing suite that can test all samples.

* Complex flow examples: redact-preview-and-finalize * /pdf-with-redacted-text-preview * /pdf-with-redacted-text-applied

* Complex flow examples: protected-watermark * /watermarked-pdf-image * /watermarked-pdf

* Complex flow examples: decrypt-add-reencrypt * /encrypted-pdf * /encrypted-pdf-new-password * /encrypted-pdf-change-password * /decrypted-pdf - deletes the decrypted outputs * /decrypted-pdf-with-permissions-password - deletes the decrypted outputs

* /restricted-pdf * /restricted-pdf-change-password * /restricted-pdf-add-password-with-open-password * /restricted-pdf-add-password-and-restrictions * /unrestricted-pdf * /unrestricted-pdf-with-open-password

* pdf-with-redacted-text-preview * pdf-with-redacted-text-applied * watermarked-pdf * encrypted-pdf * decrypted-pdf * restricted-pdf * unrestricted-pdf * Work done by Codex * Adds optional delete step to the above samples in all languages (besides cURL) with relevant comment. * For unrestricted or decrypted-pdf, delete the outputId. Otherwise, delete the inputId. * For pdf-with-redacted-text-preview samples, delete both the inputId and outputId as they are both unredacted, but add a warning comment.

* Fixes PDFWithRedactedTextPreview.java with missing bracket * Fixes remaining java samples with `mvn spotless:apply`

* Wrap whole delete block in parent if so that all variables are in scope

datalogics-tsmith · 2025-09-04T19:55:01Z

+  -H "Accept: application/json" \
+  -H "Content-Type: multipart/form-data" \
+  -H "Api-Key: $API_KEY" \
+  -F "ids=$DECRYPTED_ID, $ADDED_IMAGE_ID"


This doesn't seem to delete the output from the last curl command where the file was reencrypted

This just deletes the sensitive files that are decrypted and unrestricted (e.g. the added image file that can still be edited). This PR generally leaves the protected (e.g. encrypted, restricted, watermarked, redacted) files alone.

datalogics-tsmith · 2025-09-04T19:57:07Z

I think the optional delete steps should be commented out. Otherwise they will run by default and users who didn't read the sample may be surprised to find that their files were immediately deleted

datalogics-tsmith · 2025-09-04T20:10:42Z

+# The following code is an optional step to delete unwatermarked and 
+# watermarked files from pdfRest servers.
+
+INPUT_PDF_ID=$(jq -r '.inputId' <<< $WATERMARKED_OUTPUT)


The inputId of watermark is an array. We only have one inputid in this case since it is a text watermark but we still need to respect the array

It would need to be
INPUT_PDF_ID=$(jq -r '.inputId[0]' <<< $WATERMARKED_OUTPUT)

Fixed this for cURL but will need to fix this for the rest of the samples in other languages via codex

Fixed the non-cURL text watermark samples in 7535565

* Watermarking with text returns an inputId that is an array of 1 string id.

datalogics-kam · 2025-09-04T21:11:59Z

After I get the other conversions done for the C# samples in #110, I'll also have the AI apply the same changes as shown in the DotNET folder in this PR, and we can figure it out in merge.

Because the structure of the samples changed a little bit, and things like the API key are coming in from an env var.

* Add a toggle to turn the deletion step on or off with the PDFREST_DELETE_SENSITIVE_FILES variable. * Use PDFREST_DELETE_SENSITIVE_FILES=true to turn on the deletion step. * Update global README.md and cURL README.md to explain this logic

* Make the delete step optional by adding a local variable which the user can toggle on/off to do the delete step. * The delete step is off by default.

* Match the rest of the samples and use DELETE_SENSITIVE_FILES.

datalogics-dliang · 2025-09-05T15:02:47Z

I think the optional delete steps should be commented out. Otherwise they will run by default and users who didn't read the sample may be surprised to find that their files were immediately deleted

@datalogics-tsmith I added a local toggle in each sample so that the delete step can be turned on or off by setting the toggle to true or false. What do you think of this approach instead of commenting in and out large blocks of code? I kept the toggle as a local variable; a further improvement can be made by using environment variables in the future. I didn't go the environment variable route this time since I found we haven't standardized the way we load them (with some dotenv package or otherwise) across all the existing samples.

datalogics-kam · 2025-09-05T15:14:35Z

I like the local toggle idea, though I agree it would be also nice to have it read from an env var and default to false. That might be a lot to do for many languages right now, but I may put that in as part of the upgrade in the C# examples, which also got the environment variables and files-from-command line upgrades.

Also, I don't think the new Ruby, Perl, R, or VB.NET samples do anything with sensitive files.

datalogics-kam · 2025-09-05T17:52:57Z

I've got a version with merged in C# samples at #110, and will fix that up again once this is merged.

Also, 5e5cbb1 implements the environment variable to delete sensitive files as well.

datalogics-tsmith · 2025-09-07T22:35:19Z

+            // is involved, an explicit delete call can be made to the API.
+            //
+            // The following code is an optional step to delete sensitive files 
+            // (unredacted, unencrypted, unrestricted, or unwatermarked) from pdfRest servers.


I really think we should delete all of the files partly just to show that we can and partly since I think people who would be interested in it might still want their files to be deleted even when they are watermarked/encrypted/redacted etc

I'll go ahead and work on a change to delete all files involved in the workflow.

As of 84c05ff all cURL security samples and the base security samples in all other languages should be deleting all files in the workflow now (inputs and outputs).

datalogics-tsmith · 2025-09-07T22:36:25Z

@datalogics-tsmith I added a local toggle in each sample so that the delete step can be turned on or off by setting the toggle to true or false. What do you think of this approach instead of commenting in and out large blocks of code? I kept the toggle as a local variable; a further improvement can be made by using environment variables in the future. I didn't go the environment variable route this time since I found we haven't standardized the way we load them (with some dotenv package or otherwise) across all the existing samples.

I'm fine with this as a solution

* Updates comments, pretty-prints main request output.

* encrypted-pdf * pdf-with-redacted-text-applied * restricted-pdf * watermarked-pdf * These samples previously only deleted the input files.

* decrypted-pdf * unrestricted-pdf * pdf-with-redacted-text-preview - comment updated.

* Deletes original input file as well as the input image for adding an image

…elete

datalogics-dliang added 4 commits September 2, 2025 14:33

cURL: Add delete step to redact endpoints

94391bf

* Complex flow examples: redact-preview-and-finalize * /pdf-with-redacted-text-preview * /pdf-with-redacted-text-applied

cURL: Add delete step to watermark endpoints

3477d38

* Complex flow examples: protected-watermark * /watermarked-pdf-image * /watermarked-pdf

cURL: Add delete step to restrict endpoints

a79445f

* /restricted-pdf * /restricted-pdf-change-password * /restricted-pdf-add-password-with-open-password * /restricted-pdf-add-password-and-restrictions * /unrestricted-pdf * /unrestricted-pdf-with-open-password

datalogics-dliang changed the title ~~Add optional delete step to security endpoints~~ PDFCLOUD-5192 Add optional delete step to security endpoints Sep 2, 2025

datalogics-dliang force-pushed the security-optional-delete branch from 9871a15 to 6d7f876 Compare September 3, 2025 15:55

datalogics-dliang changed the title ~~PDFCLOUD-5192 Add optional delete step to security endpoints~~ PDFCLOUD-5192 Add optional delete step to security samples Sep 3, 2025

datalogics-dliang marked this pull request as ready for review September 4, 2025 14:02

datalogics-tsmith reviewed Sep 4, 2025

View reviewed changes

Comment thread AGENTS.md Outdated

datalogics-dliang added 4 commits September 4, 2025 14:43

Run mvn spotless:apply to Java JSON samples

a57b830

* Fixes PDFWithRedactedTextPreview.java with missing bracket * Fixes remaining java samples with `mvn spotless:apply`

Update PDFWithRedactedTextPreview.java

085dcec

* Wrap whole delete block in parent if so that all variables are in scope

PDFWithRedactedTextPreview.java: fix formatting

cbb1d91

datalogics-dliang force-pushed the security-optional-delete branch from cc2b46e to cbb1d91 Compare September 4, 2025 19:44

datalogics-tsmith reviewed Sep 4, 2025

View reviewed changes

Comment thread cURL/Endpoint Examples/JSON Payload/decrypted-pdf-with-permissions-password.sh Outdated

datalogics-tsmith reviewed Sep 4, 2025

View reviewed changes

datalogics-dliang added 2 commits September 4, 2025 15:04

Fix jq syntax errors in cURL

af4b25b

Correct typos and make headers consistent

ae73d88

datalogics-tsmith reviewed Sep 4, 2025

View reviewed changes

datalogics-dliang added 3 commits September 4, 2025 15:15

Correct complex watermark example

84b0b90

Correct basic watermark sample

fd488fe

Fix watermark samples for other languages

7535565

* Watermarking with text returns an inputId that is an array of 1 string id.

datalogics-dliang added 4 commits September 5, 2025 09:55

cURL: Make deletion step toggleable

82559c9

* Add a toggle to turn the deletion step on or off with the PDFREST_DELETE_SENSITIVE_FILES variable. * Use PDFREST_DELETE_SENSITIVE_FILES=true to turn on the deletion step. * Update global README.md and cURL README.md to explain this logic

Make delete step optional with local toggle

b53f697

* Make the delete step optional by adding a local variable which the user can toggle on/off to do the delete step. * The delete step is off by default.

Standardize variable naming in cURL

ef1c7b5

* Match the rest of the samples and use DELETE_SENSITIVE_FILES.

Format Java samples

abf0b6c

datalogics-kam mentioned this pull request Sep 5, 2025

PDFCLOUD-5217 Make the C# examples runnable (part 2, with sensitive file deletion merged in) #110

Closed

datalogics-tsmith reviewed Sep 7, 2025

View reviewed changes

datalogics-dliang added 10 commits September 8, 2025 10:52

cURL: Delete all files in workflow

5f8fb18

* Updates comments, pretty-prints main request output.

cURL: pretty-print outputs for consistency

7264252

Delete all output files

02866e7

* encrypted-pdf * pdf-with-redacted-text-applied * restricted-pdf * watermarked-pdf * These samples previously only deleted the input files.

Delete all input files

1954c5c

* decrypted-pdf * unrestricted-pdf * pdf-with-redacted-text-preview - comment updated.

Format Java comments

910f2bb

cURL: Delete input files for decrypt-add-reencrypt

84c05ff

* Deletes original input file as well as the input image for adding an image

Merge remote-tracking branch 'upstream/main' into security-optional-d…

c88dffc

…elete

Update placeholder api-key with variable

26a5c58

Fix namespace for DotNET samples

696fe94

Fix inconsistent indentation

56d31d2

datalogics-tsmith approved these changes Sep 9, 2025

View reviewed changes

datalogics-tsmith merged commit 91b5347 into pdfrest:main Sep 9, 2025
1 check passed

Conversation

datalogics-dliang commented Sep 2, 2025 • edited by datalogics-kam Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datalogics-tsmith commented Sep 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datalogics-kam commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

datalogics-dliang commented Sep 5, 2025

Uh oh!

datalogics-kam commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

datalogics-kam commented Sep 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datalogics-tsmith commented Sep 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

datalogics-dliang commented Sep 2, 2025 •

edited by datalogics-kam

Loading

datalogics-kam commented Sep 4, 2025 •

edited

Loading

datalogics-kam commented Sep 5, 2025 •

edited

Loading