Module: Yast::PackagerKeyManagerDialogsInclude

Defined in:
src/include/packager/key_manager_dialogs.rb

Overview

Helpers for creating dialogs

Instance Method Summary collapse

Instance Method Details

#AddGPGKey ⇒ Object

Display a dialog for adding a GPG key


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'src/include/packager/key_manager_dialogs.rb', line 162

def AddGPGKey
  contents = VBox(
    Frame(
      Id(:fr),
      _("Select a GPG Key"),
      MarginBox(
        1,
        0.3,
        VBox(
          HBox(
            InputField(Id(:file), Opt(:notify, :hstretch), Label.FileName),
            VBox(Label(""), PushButton(Id(:browse), Label.BrowseButton))
          )
        )
      )
    ),
    VSpacing(1),
    Frame(
      _("Properties of the GPG Key"),
      MarginBox(
        1,
        0.3,
        HBox(
          HSquash(
            VBox(
              Left(Label(_("Key ID: "))),
              Left(Label(_("Name: "))),
              Left(Label(_("Finger Print: "))),
              Left(Label(_("Created: "))),
              Left(Label(_("Expires: ")))
            )
          ),
          VBox(
            Label(Id(:key_id), Opt(:hstretch), ""),
            Label(Id(:key_name), Opt(:hstretch), ""),
            Label(Id(:key_fp), Opt(:hstretch), ""),
            Label(Id(:key_creadted), Opt(:hstretch), ""),
            Label(Id(:key_expires), Opt(:hstretch), "")
          )
        )
      )
    )
  )

  # dialog caption
  title = _("Adding a GPG Public Key")

  # help
  help_text = _("<p>\nManage known GPG public keys.</p>\n")

  help_text = Ops.add(
    help_text,
    _(
      "<p>\n" \
        "<b>Adding a New GPG Key</b><br>\n" \
        "To add a new GPG key, specify the path to the key file.\n" \
        "</p>\n"
    )
  )

  Wizard.SetNextButton(:next, Label.OKButton)
  Wizard.SetContents(title, contents, help_text, true, true)

  ret = nil
  begin
    ret = Convert.to_symbol(UI.UserInput)

    Builtins.y2debug("UserInput: %1", ret)

    if ret == :browse
      currentfile = Convert.to_string(UI.QueryWidget(Id(:file), :Value))
      # header in file selection popup
      newfile = UI.AskForExistingFile(
        currentfile,
        "*",
        _("Select a GPG Key To Import")
      )

      if !newfile.nil?
        UI.ChangeWidget(Id(:file), :Value, newfile)
        refreshNewKeyDetails(newfile)
      end
    elsif ret == :file
      keyfile = Convert.to_string(UI.QueryWidget(Id(:file), :Value))

      Builtins.y2debug("The file has changed: %1", keyfile)

      # refresh the information
      refreshNewKeyDetails(keyfile)
    elsif ret == :next
      # validate the entered file
      keyfile = Convert.to_string(UI.QueryWidget(Id(:file), :Value))
      Builtins.y2milestone("Selected file: %1", keyfile)

      if keyfile.nil? || keyfile == ""
        Report.Error(_("Enter a filename"))
        UI.SetFocus(Id(:file))
        ret = :_dummy
        next
      end

      # always add as trusted
      @added_key = KeyManager.ImportFromFile(keyfile, true)

      ret = :_dummy if @added_key.nil? || Builtins.size(@added_key).zero?
    end
  end while !Builtins.contains([:back, :abort, :next], ret)

  Wizard.RestoreNextButton

  ret
end

#createHWTable ⇒ Array

Creates a summary table with GPG key configuration

Returns:

  • (Array) —

    table contents


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
69
70
71
72
73
74
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
 
# File 'src/include/packager/key_manager_dialogs.rb', line 39

def createHWTable
  ret = []

  Builtins.foreach(KeyManager.GetKeys) do |key|
    descr = []
    # escape <> characters in the key name
    # translators: %1 is GPG key name (e.g. 'SuSE Package Signing Key <[email protected]>')
    descr = Builtins.add(
      descr,
      Builtins.sformat(
        _("Name: %1"),
        String.EscapeTags(Ops.get_string(key, "name", ""))
      )
    )
    # %1 is a GPG Key fingerprint (e.g. '79C179B2E1C820C1890F9994A84EDAE89C800ACA')
    descr = Builtins.add(
      descr,
      Builtins.sformat(
        _("Finger Print: %1"),
        Ops.get_string(key, "fingerprint", "")
      )
    )
    # %1 is the date when the GPG key was generated (e.g. '9.10.2000')
    descr = Builtins.add(
      descr,
      Builtins.sformat(_("Created: %1"), Ops.get_string(key, "created", ""))
    )
    expires = Ops.get_integer(key, "expires_raw", 0)
    exp_str = if Ops.greater_than(expires, 0) && ::Time.now.to_i > expires
      # %1 is the date when the GPG key expired (e.g. '10.6.2005'), display the date in red
      Builtins.sformat(
        _("Expires: <font color = \"red\">%1</font> (The key is expired.)"),
        Ops.get_string(key, "expires", "")
      )

    # summary string - the GPG key never expires
    elsif expires.zero?
      _("The key never expires.")
    else
      # %1 is the date when the GPG key expires (e.g. '21.3.2015') or "Never"
      Builtins.sformat(
        _("Expires: %1"),
        Ops.get_string(key, "expires", "")
      )
    end
    descr = Builtins.add(descr, exp_str)
    icon_tag = Ops.add(
      Ops.add("<IMG SRC=\"", Directory.icondir),
      "/22x22/apps/yast-security.png\">&nbsp;&nbsp;&nbsp;"
    )
    r = {
      "id"          => Ops.get_string(key, "id", ""),
      "table_descr" => [
        Ops.get_string(key, "id", ""),
        Ops.get_string(key, "name", "")
      ],
      "rich_descr"  => WizardHW.CreateRichTextDescription(
        Ops.add(
          icon_tag,
          Builtins.sformat(_("Key: %1"), Ops.get_string(key, "id", ""))
        ),
        descr
      )
    }
    ret = Builtins.add(ret, r)
  end

  Builtins.y2debug("table content: %1", ret)

  deep_copy(ret)
end

#initialize_packager_key_manager_dialogs(_include_target) ⇒ Object 


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'src/include/packager/key_manager_dialogs.rb', line 13

def initialize_packager_key_manager_dialogs(_include_target)
  Yast.import "Pkg"
  Yast.import "UI"

  textdomain "packager"

  Yast.import "Wizard"
  Yast.import "WizardHW"
  Yast.import "Label"
  Yast.import "Popup"
  Yast.import "KeyManager"
  Yast.import "String"
  Yast.import "FileUtils"
  Yast.import "Directory"
  Yast.import "Report"
  Yast.import "Sequencer"

  @gpg_mgr_standalone_mode = false

  # remember the details about the added key from AddGPGKey(),
  # the details are displayed in NewKeySummary()
  @added_key = {}
end

#KeySummary ⇒ Object

Display the main dialog for GPG key management


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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'src/include/packager/key_manager_dialogs.rb', line 276

def KeySummary
  Builtins.y2milestone("Running Summary dialog")

  # dialog caption
  title = _("GPG Public Key Management")

  # help
  help_text = _("<p>\nManage known GPG public keys.</p>\n")

  help_text = Ops.add(
    help_text,
    _(
      "<p>\n" \
        "<b>Adding a New GPG Key</b><br>\n" \
        "To add a new GPG key, use <b>Add</b> and specify the path to the key file.\n" \
        "</p>"
    )
  )

  # help, continued
  help_text = Ops.add(
    help_text,
    _(
      "<p>\n" \
        "<b>Modifying a GPG Key Status</b>\n" \
        "To modify the trusted flag, use <b>Edit</b>. To remove a GPG key, use\n" \
        "<b>Delete</b>.\n" \
        "</p>\n"
    )
  )

  # table header
  WizardHW.CreateHWDialog(title, help_text, [_("Key ID"), _("Name")], [])

  # set the navigation keys according to the current mode
  if @gpg_mgr_standalone_mode
    Wizard.DisableBackButton
    Wizard.SetNextButton(:next, Label.FinishButton)
  else
    Wizard.EnableBackButton
    Wizard.SetNextButton(:next, Label.OKButton)
  end

  ret = nil

  # set the table content
  SetItems(nil)
  begin
    ev = WizardHW.WaitForEvent
    Builtins.y2milestone("WaitForEvent: %1", ev)

    ret = Ops.get_symbol(ev, ["event", "ID"])

    # the selected key
    key_id = Ops.get_string(ev, "selected", "")

    Builtins.y2milestone("Selected key: %1, action: %2", key_id, ret)

    # remove the key
    if ret == :delete
      key = KeyManager.SearchGPGKey(key_id)

      if Popup.YesNo(
        Builtins.sformat(
          _("Really delete key '%1'\n'%2'?"),
          key_id,
          Ops.get_string(key, "name", "")
        )
      )
        KeyManager.DeleteKey(key_id)
        # refresh the table
        SetItems(nil)

        # HACK: - refresh (clear) the rich text part of the dialog
        # TODO: fix a bug in WizardHW?
        SetItems("") if Builtins.size(KeyManager.GetKeys).zero?
      end
    end
  end while !Builtins.contains([:back, :abort, :next, :add], ret)

  ret
end

#refreshNewKeyDetails(file) ⇒ Object 


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'src/include/packager/key_manager_dialogs.rb', line 130

def refreshNewKeyDetails(file)
  key = {}

  # at first check whether the file exists at all
  if FileUtils.Exists(file)
    # check whether the file contains a valid GPG key
    key = Pkg.CheckGPGKeyFile(file)
    Builtins.y2milestone("File content: %1", key)
  end

  UI.ChangeWidget(Id(:key_id), :Value, Ops.get_string(key, "id", ""))
  UI.ChangeWidget(Id(:key_name), :Value, Ops.get_string(key, "name", ""))
  UI.ChangeWidget(
    Id(:key_fp),
    :Value,
    Ops.get_string(key, "fingerprint", "")
  )
  UI.ChangeWidget(
    Id(:key_creadted),
    :Value,
    Ops.get_string(key, "created", "")
  )
  UI.ChangeWidget(
    Id(:key_expires),
    :Value,
    Ops.get_string(key, "expires", "")
  )

  nil
end

#RunGPGKeyMgmt(standalone) ⇒ Object

Run the GPG key management workflow


360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'src/include/packager/key_manager_dialogs.rb', line 360

def RunGPGKeyMgmt(standalone)
  @gpg_mgr_standalone_mode = standalone

  aliases = { "summary" => -> { KeySummary() }, "add" => [lambda do
    AddGPGKey()
  end, true] }

  sequence = {
    "ws_start" => "summary",
    "summary"  => { abort: :abort, next: :next, add: "add" },
    "add"      => { next: "summary", abort: :abort }
  }

  Builtins.y2milestone(
    "Starting the key management sequence (standalone: %1)",
    standalone
  )
  ret = Sequencer.Run(aliases, sequence)

  ret
end

#SetItems(selected_key) ⇒ Object

Set/refresh the table content


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'src/include/packager/key_manager_dialogs.rb', line 112

def SetItems(selected_key)
  # create description for WizardHW
  items = createHWTable
  Builtins.y2debug("items: %1", items)

  WizardHW.SetContents(items)

  if !selected_key.nil?
    # set the previously selected key
    WizardHW.SetSelectedItem(selected_key)
  end

  # properties of a key cannot be changed, disable Edit button
  UI.ChangeWidget(Id(:edit), :Enabled, false)

  nil
end