Class: Fastlane::Actions::CreateKeychainAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/create_keychain.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, details, lane_context, method_missing, other_action, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authors ⇒ Object 



154
155
156
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 154

def self.authors
  ["gin0606"]
end

.available_options ⇒ Object 



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
151
152
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 105

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :name,
                                 env_name: "KEYCHAIN_NAME",
                                 description: "Keychain name",
                                 conflicting_options: [:path],
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "KEYCHAIN_PATH",
                                 description: "Path to keychain",
                                 conflicting_options: [:name],
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "KEYCHAIN_PASSWORD",
                                 description: "Password for the keychain",
                                 sensitive: true,
                                 code_gen_sensitive: true,
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :default_keychain,
                                 description: 'Should the newly created Keychain be the new system default keychain',
                                 type: Boolean,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :unlock,
                                 description: 'Unlock keychain after create',
                                 type: Boolean,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :timeout,
                                 description: 'timeout interval in seconds. Set `0` if you want to specify "no time-out"',
                                 type: Integer,
                                 default_value: 300),
    FastlaneCore::ConfigItem.new(key: :lock_when_sleeps,
                                 description: 'Lock keychain when the system sleeps',
                                 type: Boolean,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :lock_after_timeout,
                                 description: 'Lock keychain after timeout interval',
                                 type: Boolean,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :add_to_search_list,
                                 description: 'Add keychain to search list',
                                 type: Boolean,
                                 default_value: true),
    FastlaneCore::ConfigItem.new(key: :require_create,
                                 description: 'Fail the action if the Keychain already exists',
                                 type: Boolean,
                                 default_value: false)
  ]
end

.category ⇒ Object 



174
175
176
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 174

def self.category
  :misc
end

.description ⇒ Object 



94
95
96
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 94

def self.description
  "Create a new Keychain"
end

.example_code ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 162

def self.example_code
  [
    'create_keychain(
      name: "KeychainName",
      default_keychain: true,
      unlock: true,
      timeout: 3600,
      lock_when_sleeps: true
    )'
  ]
end

.exists?(keychain_path) ⇒ Boolean

Returns:



78
79
80
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 78

def self.exists?(keychain_path)
  !resolved_keychain_path(keychain_path).nil?
end

.is_supported?(platform) ⇒ Boolean

Returns:



158
159
160
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 158

def self.is_supported?(platform)
  true
end

.list_keychains ⇒ Object 



74
75
76
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 74

def self.list_keychains
  Action.sh("security list-keychains -d user").shellsplit
end

.output ⇒ Object 



98
99
100
101
102
103
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 98

def self.output
  [
    ['ORIGINAL_DEFAULT_KEYCHAIN', 'The path to the default keychain'],
    ['KEYCHAIN_PATH', 'The path of the keychain']
  ]
end

.resolved_keychain_path(keychain_path) ⇒ Object

returns the expanded and resolved path for the keychain, or nil if not found



83
84
85
86
87
88
89
90
91
92
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 83

def self.resolved_keychain_path(keychain_path)
  keychain_path = File.expand_path(keychain_path)

  # Creating Keychains using the security
  # CLI appends `-db` to the file name.
  ["#{keychain_path}-db", keychain_path].each do |path|
    return path if File.exist?(path)
  end
  nil
end

.run(params) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
69
70
71
72
 
# File 'fastlane/lib/fastlane/actions/create_keychain.rb', line 11

def self.run(params)
  escaped_password = params[:password].shellescape

  if params[:name]
    escaped_name = params[:name].shellescape
    keychain_path = "~/Library/Keychains/#{escaped_name}"
  else
    keychain_path = params[:path].shellescape
  end

  if keychain_path.nil?
    UI.user_error!("You either have to set :name or :path")
  end

  commands = []

  if !exists?(keychain_path)
    commands << Fastlane::Actions.sh("security create-keychain -p #{escaped_password} #{keychain_path}", log: false)
  elsif params[:require_create]
    UI.abort_with_message!("`require_create` option passed, but found keychain '#{keychain_path}', failing create_keychain action")
  else
    UI.important("Found keychain '#{keychain_path}', creation skipped")
    UI.important("If creating a new Keychain DB is required please set the `require_create` option true to cause the action to fail")
  end

  Actions.lane_context[Actions::SharedValues::KEYCHAIN_PATH] = keychain_path

  if params[:default_keychain]
    # if there is no default keychain - setting the original will fail - silent this error
    begin
      Actions.lane_context[Actions::SharedValues::ORIGINAL_DEFAULT_KEYCHAIN] = Fastlane::Actions.sh("security default-keychain", log: false).strip
    rescue
    end
    commands << Fastlane::Actions.sh("security default-keychain -s #{keychain_path}", log: false)
  end

  commands << Fastlane::Actions.sh("security unlock-keychain -p #{escaped_password} #{keychain_path}", log: false) if params[:unlock]

  command = "security set-keychain-settings"

  # https://ss64.com/osx/security-keychain-settings.html
  # omitting 'timeout' option to specify "no timeout" if required
  command << " -t #{params[:timeout]}" if params[:timeout] > 0
  command << " -l" if params[:lock_when_sleeps]
  command << " -u" if params[:lock_after_timeout]
  command << " #{keychain_path}"

  commands << Fastlane::Actions.sh(command, log: false)

  if params[:add_to_search_list]
    keychains = list_keychains
    expanded_path = resolved_keychain_path(keychain_path)
    if keychains.include?(expanded_path)
      UI.important("Found keychain '#{expanded_path}' in list-keychains, adding to search list skipped")
    else
      keychains << expanded_path
      commands << Fastlane::Actions.sh("security list-keychains -s #{keychains.shelljoin}", log: false)
    end
  end

  commands
end