Class: DynamicPDFApi::Aes256Security

Inherits:
Security
  • Object
show all
Defined in:
lib/ruby_client/Aes256Security.rb

Overview

Represents AES 256 bit PDF document security.

AES 256 bit PDF security is compatible with PDF version 1.5 and higher. This class is FIPS compliant when used in applications targeting .NET framework v3.5 or higher. Adobe Acrobat Reader version X or higher is needed to open these documents.

Instance Attribute Summary collapse

Attributes inherited from Security

#allow_accessibility, #allow_copy, #allow_document_assembly, #allow_edit, #allow_form_filling, #allow_high_resolution_printing, #allow_print, #allow_update_annots_and_fields, #owner_password, #user_password

Instance Method Summary collapse

Constructor Details

#initialize(user_password, owner_password) ⇒ Aes256Security

Initializes a new instance of the Aes256Security class by taking the owner and user passwords as parameters to create PDF.

Parameters:

  • owner_password (String) —

    The owner password to open the document.

  • user_password (String) —

    The user password to open the document.



22
23
24
25
26
 
# File 'lib/ruby_client/Aes256Security.rb', line 22

def initialize(user_password, owner_password)
  @document_components = nil
  @_type = SecurityType::AES_256
  super(user_password, owner_password)
end

Instance Attribute Details

#document_components ⇒ Object

Gets or sets the EncryptDocumentComponents, components of the document to be encrypted. We can encrypt all the PDF content or the content, excluding the metadata.



32
33
34
 
# File 'lib/ruby_client/Aes256Security.rb', line 32

def document_components
  @document_components
end

Instance Method Details

#to_json(_options = {}) ⇒ Object 



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
 
# File 'lib/ruby_client/Aes256Security.rb', line 34

def to_json(_options = {})
  json_array = {}
  json_array['type'] = 'aes256'

  json_array['documentComponents'] = @document_components.downcase unless @document_components.nil?

  #-------------------------------------------
  json_array['allowCopy'] = @allow_copy unless @allow_copy.nil?

  json_array['allowEdit'] = @allow_edit unless @allow_edit.nil?

  json_array['allowPrint'] = @allow_print unless @allow_print.nil?

  unless @allow_update_annots_and_fields.nil?
    json_array['allowUpdateAnnotsAndFields'] =
      @allow_update_annots_and_fields
  end

  json_array['ownerPassword'] = @owner_password unless @owner_password.nil?

  json_array['userPassword'] = @user_password unless @user_password.nil?

  json_array['allowAccessibility'] = @allow_accessibility unless @allow_accessibility.nil?

  json_array['allowFormFilling'] = @allow_form_filling unless @allow_form_filling.nil?

  unless @allow_high_resolution_printing.nil?
    json_array['allowHighResolutionPrinting'] =
      @allow_high_resolution_printing
  end

  json_array['allowDocumentAssembly'] = @allow_document_assembly unless @allow_document_assembly.nil?

  JSON.pretty_generate(json_array)
end