Class: Hiera::Backend::Eyaml::Subcommands::Edit
Class Method Summary
collapse
all_options, attach_option, find, hidden?, load_config_file, parse, prettyname
Class Method Details
.description ⇒ Object
24
25
26
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 24
def self.description
"edit an eyaml file"
end
|
.execute ⇒ Object
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 75
def self.execute
editor = EditHelper.find_editor
Parser::EncToken.set_encrypt_unchanged(false)
if Eyaml::Options[:no_decrypt_given]
decrypted_input = Eyaml::Options[:input_data]
decrypted_file_content = Eyaml::Options[:no_preamble] ? decrypted_input : (self.preamble + decrypted_input)
else
encrypted_parser = Parser::ParserFactory.encrypted_parser
tokens = encrypted_parser.parse Eyaml::Options[:input_data]
decrypted_input = tokens.each_with_index.to_a.map{|(t,index)| t.to_decrypted :index => index}.join
decrypted_file_content = Eyaml::Options[:no_preamble] ? decrypted_input : (self.preamble + decrypted_input)
end
begin
decrypted_file = EditHelper.write_tempfile decrypted_file_content unless decrypted_file
system "#{editor} \"#{decrypted_file}\""
status = $?
raise StandardError, "File was moved by editor" unless File.file? decrypted_file
raw_edited_file = File.read decrypted_file
edited_file = raw_edited_file.split($/,-1).drop_while {|line| line.start_with?(self.prefix)}.join($/)
raise StandardError, "Editor #{editor} has not exited?" unless status.exited?
raise StandardError, "Editor did not exit successfully (exit code #{status.exitstatus}), aborting" unless status.exitstatus == 0
raise StandardError, "Edited file is blank" if edited_file.empty?
if edited_file == decrypted_input
LoggingHelper.info "No changes detected, exiting"
else
decrypted_parser = Parser::ParserFactory.decrypted_parser
edited_tokens = decrypted_parser.parse(edited_file)
used_ids = edited_tokens.find_all{ |t| t.class.name =~ /::EncToken$/ and !t.id.nil? }.map{ |t| t.id }
if used_ids.length != used_ids.uniq.length
raise RecoverableError, "A duplicate DEC(ID) was found so I don't know how to proceed. This is probably because you copy and pasted a value - if you do this please delete the ID and parentheses"
end
edited_denoised_tokens = edited_tokens.map{ |token|
if token.class.name =~ /::EncToken$/ && !token.id.nil?
old_token = tokens[token.id]
if old_token.plain_text.eql? token.plain_text
old_token
else
token
end
else
token
end
}
encrypted_output = edited_denoised_tokens.map{ |t| t.to_encrypted }.join
filename = Eyaml::Options[:eyaml]
File.open("#{filename}", 'w') { |file|
file.write encrypted_output
}
end
rescue RecoverableError => e
LoggingHelper.info e
if agree "Return to the editor to try again?"
retry
else
raise e
end
ensure
EditHelper.secure_file_delete :file => decrypted_file, :num_bytes => [edited_file.length, decrypted_input.length].max
end
nil
end
|
.helptext ⇒ Object
28
29
30
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 28
def self.helptext
"Usage: eyaml edit [options] <some-eyaml-file>"
end
|
.options ⇒ Object
15
16
17
18
19
20
21
22
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 15
def self.options
[{ :name => :no_preamble,
:description => "Don't prefix edit sessions with the informative preamble" },
{:name => :no_decrypt,
:short => "-d",
:description => "Do not decrypt existing encrypted content. New content marked properly will be encrypted."}
]
end
|
.preamble ⇒ Object
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 36
def self.preamble
tags = (["pkcs7"] + Plugins.plugins.collect {|plugin|
plugin.name.split("hiera-eyaml-").last
}).collect{|name| Encryptor.find(name).tag}
preamble = <<-eos
This is eyaml edit mode. This text (lines starting with #{self.prefix} at the top of
the file) will be removed when you save and exit.
- To edit encrypted values, change the content of the DEC(<num>)::PKCS7[]!
block#{(tags.size>1) ? " (or #{tags.drop(1).collect {|tag| "DEC(<num>)::#{tag}[]!" }.join(' or ')})." : '.' }
WARNING: DO NOT change the number in the parentheses.
- To add a new encrypted value copy and paste a new block from the
appropriate example below. Note that:
* the text to encrypt goes in the square brackets
* ensure you include the exclamation mark when you copy and paste
* you must not include a number when adding a new block
e.g. #{tags.collect {|tag| "DEC::#{tag}[]!" }.join(' -or- ')}
eos
preamble.gsub(/^/, "#{self.prefix} ")
end
|
.prefix ⇒ Object
32
33
34
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 32
def self.prefix
'# |'
end
|
.validate(options) ⇒ Object
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# File 'lib/hiera/backend/eyaml/subcommands/edit.rb', line 58
def self.validate options
Optimist::die "You must specify an eyaml file" if ARGV.empty?
options[:source] = :eyaml
options[:eyaml] = ARGV.shift
if File.exists? options[:eyaml]
begin
options[:input_data] = File.read options[:eyaml]
rescue
raise StandardError, "Could not open file for reading: #{options[:eyaml]}"
end
else
LoggingHelper.info "#{options[:eyaml]} doesn't exist, editing new file"
options[:input_data] = "---"
end
options
end
|