Class: SymmetricEncryption::Reader
- Inherits:
-
Object
- Object
- SymmetricEncryption::Reader
- Defined in:
- lib/symmetric_encryption/reader.rb
Overview
Read from encrypted files and other IO streams
Features:
-
Decryption on the fly whilst reading files
-
Large file support by only buffering small amounts of data in memory
Instance Attribute Summary collapse
-
#pos ⇒ Object
readonly
Return the number of bytes read so far from the input stream.
-
#version ⇒ Object
readonly
Returns the Cipher encryption version used to encrypt this file Returns nil when the header was not present in the stream and no :version option was supplied.
Class Method Summary collapse
-
.decrypt(source:, target:, **args) ⇒ Object
Decrypt an entire file.
-
.empty?(file_name_or_stream) ⇒ Boolean
Returns [true|false] whether the file or stream contains any data excluding the header should it have one.
-
.header_present?(file_name) ⇒ Boolean
Returns [true|false] whether the file contains the encryption header.
-
.open(file_name_or_stream, buffer_size: 16_384, **args, &block) ⇒ Object
Open a file for reading, or use the supplied IO Stream.
-
.read(file_name_or_stream, **args) ⇒ Object
Read the entire contents of a file or stream into memory.
Instance Method Summary collapse
-
#close(close_child_stream = true) ⇒ Object
Close the IO Stream.
-
#compressed? ⇒ Boolean
Returns whether the stream being read is compressed.
-
#each_line(sep_string = "\n") ⇒ Object
(also: #each)
ios.each(sep_string=“n”) {|line| block } => ios ios.each_line(sep_string=“n”) {|line| block } => ios Executes the block for every line in ios, where lines are separated by sep_string.
-
#eof? ⇒ Boolean
Returns whether the end of file has been reached for this stream.
-
#flush ⇒ Object
Flush the read stream Needed by XLS gem.
-
#gets(sep_string, length = nil) ⇒ Object
Reads a single decrypted line from the file up to and including the optional sep_string.
-
#header_present? ⇒ Boolean
After opening a file Returns [true|false] whether the file being read has an encryption header.
-
#initialize(ios, buffer_size: 4096, version: nil) ⇒ Reader
constructor
Decrypt data before reading from the supplied stream.
-
#read(length = nil, outbuf = nil) ⇒ Object
Read from the stream and return the decrypted data See IOS#read.
-
#readline(sep_string = "\n") ⇒ Object
Reads a single decrypted line from the file up to and including the optional sep_string.
-
#rewind ⇒ Object
Rewind back to the beginning of the file.
-
#seek(amount, whence = IO::SEEK_SET) ⇒ Object
Seeks to a given offset (Integer) in the stream according to the value of whence: IO::SEEK_CUR | Seeks to amount plus current position ————–+—————————————————- IO::SEEK_END | Seeks to amount plus end of stream (you probably | want a negative value for amount) ————–+—————————————————- IO::SEEK_SET | Seeks to the absolute location given by amount.
-
#size ⇒ Object
Return the size of the file rounded up to the nearest encryption block size Needed by XLS gem.
Constructor Details
#initialize(ios, buffer_size: 4096, version: nil) ⇒ Reader
Decrypt data before reading from the supplied stream
117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/symmetric_encryption/reader.rb', line 117 def initialize(ios, buffer_size: 4096, version: nil) @ios = ios @buffer_size = buffer_size @version = version @header_present = false @closed = false @read_buffer = "".b raise(ArgumentError, "Buffer size cannot be smaller than 128") unless @buffer_size >= 128 read_header end |
Instance Attribute Details
#pos ⇒ Object (readonly)
Return the number of bytes read so far from the input stream
253 254 255 |
# File 'lib/symmetric_encryption/reader.rb', line 253 def pos @pos end |
#version ⇒ Object (readonly)
Returns the Cipher encryption version used to encrypt this file Returns nil when the header was not present in the stream and no :version
option was supplied
Note: When no header is present, the version is set to the one supplied
in the options
151 152 153 |
# File 'lib/symmetric_encryption/reader.rb', line 151 def version @version end |
Class Method Details
.decrypt(source:, target:, **args) ⇒ Object
Decrypt an entire file.
Returns [Integer] the number of unencrypted bytes written to the target file.
Params:
source: [String|IO]
Source file_name or IOStream
target: [String|IO]
Target file_name or IOStream
Notes:
-
The file contents are streamed so that the entire file is not loaded into memory.
95 96 97 |
# File 'lib/symmetric_encryption/reader.rb', line 95 def self.decrypt(source:, target:, **args) Reader.open(source, **args) { |input_file| IO.copy_stream(input_file, target) } end |
.empty?(file_name_or_stream) ⇒ Boolean
Returns [true|false] whether the file or stream contains any data excluding the header should it have one
101 102 103 |
# File 'lib/symmetric_encryption/reader.rb', line 101 def self.empty?(file_name_or_stream) open(file_name_or_stream, &:eof?) end |
.header_present?(file_name) ⇒ Boolean
Returns [true|false] whether the file contains the encryption header
106 107 108 |
# File 'lib/symmetric_encryption/reader.rb', line 106 def self.header_present?(file_name) ::File.open(file_name, "rb") { |file| new(file).header_present? } end |
.open(file_name_or_stream, buffer_size: 16_384, **args, &block) ⇒ Object
Open a file for reading, or use the supplied IO Stream
Parameters:
file_name_or_stream:
The file_name to open if a string, otherwise the stream to use
The file or stream will be closed on completion, use .initialize to
avoid having the stream closed automatically
buffer_size:
Amount of data to read at a time.
Minimum Value 128
Default: 16384
Note: Decryption occurs before decompression
# Example: Read and decrypt a line at a time from a file SymmetricEncryption::Reader.open(‘test_file’) do |file|
file.each_line {|line| p line }
end
# Example: Read and decrypt entire file in memory # Not recommended for large files SymmetricEncryption::Reader.open(‘test_file’) {|f| f.read }
# Example: Reading a limited number of bytes at a time from the file SymmetricEncryption::Reader.open(‘test_file’) do |file|
file.read(1)
file.read(5)
file.read
end
# Example: Read and decrypt 5 bytes at a time until the end of file is reached SymmetricEncryption::Reader.open(‘test_file’) do |file|
while !file.eof? do
file.read(5)
end
end
# Example: Read, Unencrypt and decompress data in a file SymmetricEncryption::Reader.open(‘encrypted_compressed.zip’, compress: true) do |file|
file.each_line {|line| p line }
end
# Example: Reading from a CSV file
require ‘csv’ begin
csv = CSV.new(SymmetricEncryption::Reader.open('csv_encrypted'))
csv.each {|row| p row}
ensure
csv.close if csv
end
62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/symmetric_encryption/reader.rb', line 62 def self.open(file_name_or_stream, buffer_size: 16_384, **args, &block) ios = file_name_or_stream.is_a?(String) ? ::File.open(file_name_or_stream, "rb") : file_name_or_stream begin file = new(ios, buffer_size: buffer_size, **args) file = Zlib::GzipReader.new(file) if !file.eof? && file.compressed? block ? block.call(file) : file ensure file.close if block && file && (file.respond_to?(:closed?) && !file.closed?) end end |
.read(file_name_or_stream, **args) ⇒ Object
Read the entire contents of a file or stream into memory.
Notes:
-
Do not use this method for reading large files.
78 79 80 |
# File 'lib/symmetric_encryption/reader.rb', line 78 def self.read(file_name_or_stream, **args) Reader.open(file_name_or_stream, **args, &:read) end |
Instance Method Details
#close(close_child_stream = true) ⇒ Object
Close the IO Stream
Note: Also closes the passed in io stream or file
It is recommended to call Symmetric::EncryptedStream.open or Symmetric::EncryptedStream.io rather than creating an instance of Symmetric::EncryptedStream directly to ensure that the encrypted stream is closed before the stream itself is closed
160 161 162 163 164 165 |
# File 'lib/symmetric_encryption/reader.rb', line 160 def close(close_child_stream = true) return if closed? @ios.close if close_child_stream @closed = true end |
#compressed? ⇒ Boolean
Returns whether the stream being read is compressed
Should be called before any reads are performed to determine if the file or stream is compressed.
Returns true when the header is present in the stream and it is compressed Returns false when the header is present in the stream and it is not compressed Returns nil when the header is not present in the stream
Note: The file will not be decompressed automatically when compressed.
To decompress the data automatically call SymmetricEncryption.open
141 142 143 |
# File 'lib/symmetric_encryption/reader.rb', line 141 def compressed? @compressed end |
#each_line(sep_string = "\n") ⇒ Object Also known as: each
ios.each(sep_string=“n”) {|line| block } => ios ios.each_line(sep_string=“n”) {|line| block } => ios Executes the block for every line in ios, where lines are separated by sep_string. ios must be opened for reading or an IOError will be raised.
240 241 242 243 |
# File 'lib/symmetric_encryption/reader.rb', line 240 def each_line(sep_string = "\n") yield gets(sep_string) until eof? self end |
#eof? ⇒ Boolean
Returns whether the end of file has been reached for this stream
248 249 250 |
# File 'lib/symmetric_encryption/reader.rb', line 248 def eof? @read_buffer.empty? && @ios.eof? end |
#flush ⇒ Object
Flush the read stream
Needed by XLS gem
169 170 171 |
# File 'lib/symmetric_encryption/reader.rb', line 169 def flush @ios.flush end |
#gets(sep_string, length = nil) ⇒ Object
Reads a single decrypted line from the file up to and including the optional sep_string. A sep_string of nil reads the entire contents of the file Returns nil on eof The stream must be opened for reading or an IOError will be raised.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/symmetric_encryption/reader.rb', line 219 def gets(sep_string, length = nil) return read(length) if sep_string.nil? # Read more data until we get the sep_string while (index = @read_buffer.index(sep_string)).nil? && !@ios.eof? break if length && @read_buffer.length >= length read_block end index ||= -1 data = @read_buffer.slice!(0..index) @pos += data.length return nil if data.empty? && eof? data end |
#header_present? ⇒ Boolean
After opening a file Returns [true|false] whether the file being read has an encryption header
112 113 114 |
# File 'lib/symmetric_encryption/reader.rb', line 112 def header_present? @header_present end |
#read(length = nil, outbuf = nil) ⇒ Object
Read from the stream and return the decrypted data See IOS#read
Reads at most length bytes from the I/O stream, or to the end of file if length is omitted or is nil. length must be a non-negative integer or nil.
At end of file, it returns nil if no more data is available, or the last remaining bytes
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/symmetric_encryption/reader.rb', line 187 def read(length = nil, outbuf = nil) data = outbuf.nil? ? "" : outbuf.clear remaining_length = length until remaining_length&.zero? || eof? read_block(remaining_length) if @read_buffer.empty? if remaining_length && remaining_length < @read_buffer.length data << @read_buffer.slice!(0, remaining_length) else data << @read_buffer @read_buffer.clear end remaining_length = length - data.length if length end @pos += data.length data unless data.empty? && length && length.positive? end |
#readline(sep_string = "\n") ⇒ Object
Reads a single decrypted line from the file up to and including the optional sep_string. Raises EOFError on eof The stream must be opened for reading or an IOError will be raised.
211 212 213 |
# File 'lib/symmetric_encryption/reader.rb', line 211 def readline(sep_string = "\n") gets(sep_string) || raise(EOFError, "End of file reached when trying to read a line") end |
#rewind ⇒ Object
Rewind back to the beginning of the file
256 257 258 259 260 |
# File 'lib/symmetric_encryption/reader.rb', line 256 def rewind @read_buffer.clear @ios.rewind read_header end |
#seek(amount, whence = IO::SEEK_SET) ⇒ Object
Seeks to a given offset (Integer) in the stream according to the value of whence:
IO::SEEK_CUR | Seeks to _amount_ plus current position
--------------+----------------------------------------------------
IO::SEEK_END | Seeks to _amount_ plus end of stream (you probably
| want a negative value for _amount_)
--------------+----------------------------------------------------
IO::SEEK_SET | Seeks to the absolute location given by _amount_
WARNING: IO::SEEK_SET will jump to the beginning of the file and
then re-read upto the point specified
WARNING: IO::SEEK_END will read the entire file and then again
upto the point specified
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 |
# File 'lib/symmetric_encryption/reader.rb', line 274 def seek(amount, whence = IO::SEEK_SET) offset = 0 case whence when IO::SEEK_SET offset = amount rewind when IO::SEEK_CUR if amount >= 0 offset = amount else offset = @pos + amount rewind end when IO::SEEK_END rewind # Read and decrypt entire file a block at a time to get its total # unencrypted size size = 0 until eof? read_block size += @read_buffer.size @read_buffer.clear end rewind offset = size + amount else raise(ArgumentError, "unknown whence:#{whence} supplied to seek()") end read(offset) if offset.positive? 0 end |
#size ⇒ Object
Return the size of the file rounded up to the nearest encryption block size
Needed by XLS gem
175 176 177 |
# File 'lib/symmetric_encryption/reader.rb', line 175 def size @ios.size end |