Class: Fastlane::Actions::CreateKeychainAction

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

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, details, output, return_value, sh, step_text

Class Method Details

.authors ⇒ Object 



82
83
84
 
# File 'lib/fastlane/actions/create_keychain.rb', line 82

def self.authors
  ["gin0606"]
end

.available_options ⇒ Object 



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

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :name,
                                 env_name: "KEYCHAIN_NAME",
                                 description: "Keychain name",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "KEYCHAIN_PASSWORD",
                                 description: "Password for the keychain",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :default_keychain,
                                 description: 'Set the default keychain',
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :unlock,
                                 description: 'Unlock keychain after create',
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :timeout,
                                 description: 'timeout interval in seconds. Set `false` if you want to specify "no time-out"',
                                 is_string: false,
                                 default_value: 300),
    FastlaneCore::ConfigItem.new(key: :lock_when_sleeps,
                                 description: 'Lock keychain when the system sleeps',
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :lock_after_timeout,
                                 description: 'Lock keychain after timeout interval',
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :add_to_search_list,
                                 description: 'Add keychain to search list',
                                 is_string: false,
                                 default_value: true)
  ]
end

.description ⇒ Object 



41
42
43
 
# File 'lib/fastlane/actions/create_keychain.rb', line 41

def self.description
  "Create a new Keychain"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/fastlane/actions/create_keychain.rb', line 86

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



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

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

  commands = []
  commands << Fastlane::Actions.sh("security create-keychain -p #{escaped_password} #{escaped_name}", log: false)

  if params[:default_keychain]
    Actions.lane_context[Actions::SharedValues::ORIGINAL_DEFAULT_KEYCHAIN] = Fastlane::Actions.sh("security default-keychain", log: false).strip
    commands << Fastlane::Actions.sh("security default-keychain -s #{escaped_name}", log: false)
  end

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

  command = "security set-keychain-settings"
  command << " -t #{params[:timeout]}" if params[:timeout]
  command << " -l" if params[:lock_when_sleeps]
  command << " -u" if params[:lock_after_timeout]
  command << " ~/Library/Keychains/#{escaped_name}"

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

  if params[:add_to_search_list]
    keychains = Action.sh("security list-keychains -d user").shellsplit
    keychains << File.expand_path(params[:name], "~/Library/Keychains")
    commands << Fastlane::Actions.sh("security list-keychains -s #{keychains.shelljoin}", log: false)
  end

  commands
end