Class: Fastlane::Actions::HexsignCertificatesDownloadByTypeAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



43
44
45
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 43

def self.authors
  ["HexSign"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 67

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :type,
      env_name: "HEXSIGN_CERTIFICATE_TYPE",
      description: "Apple certificate type, e.g. IOS_DISTRIBUTION",
      optional: false,
      type: String
    ),
    FastlaneCore::ConfigItem.new(
      key: :team_id,
      env_name: "HEXSIGN_TEAM_ID",
      description: "Apple Developer team identifier to scope the download to",
      optional: false,
      type: String
    ),
    FastlaneCore::ConfigItem.new(
      key: :output_dir,
      env_name: "HEXSIGN_CERTIFICATE_OUTPUT_DIR",
      description: "Directory to write the .p12 and .password files into",
      optional: true,
      type: String
    ),
    FastlaneCore::ConfigItem.new(
      key: :keychain,
      env_name: "HEXSIGN_KEYCHAIN",
      description: "macOS only: create this keychain and import every downloaded .p12 into it, ready for codesigning",
      optional: true,
      type: String
    )
  ]
end

.category ⇒ Object 



125
126
127
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 125

def self.category
  :code_signing
end

.description ⇒ Object 



39
40
41
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 39

def self.description
  "Download every signing certificate of a given type for one Apple Developer team via the HexSign CLI."
end

.details ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 47

def self.details
  <<~DETAILS
    Wraps `hexsign certificates download --type <T> --team-id <ID>`. Returns an
    array of { p12:, password: } hashes — one per downloaded certificate.

    Survives certificate rotation: you point at a cert type (e.g. IOS_DISTRIBUTION)
    rather than a specific UUID that changes when a cert is renewed.

    The hexsign binary must be on PATH — install via `brew install hexsign` or the
    hexsign/hexsign-cli GitHub Action. Set HEXSIGN_CLIENT_ID and HEXSIGN_CLIENT_SECRET
    so the CLI runs in machine mode.

    Accepted types: IOS_DEVELOPMENT, IOS_DISTRIBUTION, MAC_APP_DEVELOPMENT,
    MAC_APP_DISTRIBUTION, MAC_INSTALLER_DISTRIBUTION, DEVELOPER_ID_APPLICATION,
    DEVELOPER_ID_APPLICATION_G2, DEVELOPER_ID_KEXT, DEVELOPER_ID_KEXT_G2,
    DEVELOPER_ID_INSTALLER, DEVELOPMENT, DISTRIBUTION, PASS_TYPE_ID,
    PASS_TYPE_ID_WITH_NFC.
  DETAILS
end

.example_code ⇒ Object 



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 114

def self.example_code
  [
    'pairs = hexsign_certificates_download_by_type(
      type: "IOS_DISTRIBUTION",
      team_id: "ABCDE12345",
      output_dir: "build/sign"
    )
    # => [{ p12: "build/sign/foo.p12", password: "build/sign/foo.password" }, ...]'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 110

def self.is_supported?(platform)
  %i[ios mac tvos watchos visionos].include?(platform)
end

.output ⇒ Object 



100
101
102
103
104
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 100

def self.output
  [
    ["HEXSIGN_CERTIFICATES_DOWNLOAD_BY_TYPE_COUNT", "Number of certificates downloaded"]
  ]
end

.parse_stdout(stdout) ⇒ Object

The CLI prints two lines per certificate: .p12 path then .password path. With –keychain it also prints a trailing “imported N certificate(s)…” summary line, which is dropped by keeping only file-path lines. Returns [{ p12: “…”, password: “…” }, …].



29
30
31
32
33
34
35
36
37
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 29

def self.parse_stdout(stdout)
  lines = stdout.split("\n").map(&:strip).reject(&:empty?)
  lines = lines.select { |line| line.end_with?(".p12", ".password") }
  pairs = []
  lines.each_slice(2) do |p12, password|
    pairs << { p12: p12, password: password }
  end
  pairs
end

.return_value ⇒ Object 



106
107
108
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 106

def self.return_value
  "Array of { p12:, password: } hashes — one per downloaded certificate."
end

.run(params) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/fastlane/plugin/hexsign/actions/hexsign_certificates_download_by_type.rb', line 9

def self.run(params)
  args = [
    "certificates", "download",
    "--type", params[:type],
    "--team-id", params[:team_id]
  ]
  args.push("--output-dir", params[:output_dir]) if params[:output_dir]
  args.push("--keychain", params[:keychain]) if params[:keychain]

  stdout = Helper::HexsignHelper.run(args)
  pairs = parse_stdout(stdout)

  UI.success("Downloaded #{pairs.size} #{params[:type]} certificate(s) for team #{params[:team_id]}")
  pairs
end