Module: Cask::Quarantine Private

Defined in:
Library/Homebrew/cask/quarantine.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Helper module for quarantining files.

Constant Summary collapse

QUARANTINE_ATTRIBUTE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"com.apple.quarantine"
QUARANTINE_SCRIPT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

(HOMEBREW_LIBRARY_PATH/"cask/utils/quarantine.swift").freeze

Class Method Summary collapse

Class Method Details

.available?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

56
57
58
59
60
# File 'Library/Homebrew/cask/quarantine.rb', line 56

def available?
  @status ||= check_quarantine_support

  @status == :quarantine_available
end

.cask!(cask: nil, download_path: nil, action: true) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


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
# File 'Library/Homebrew/cask/quarantine.rb', line 110

def cask!(cask: nil, download_path: nil, action: true)
  return if cask.nil? || download_path.nil?

  return if detect(download_path)

  odebug "Quarantining #{download_path}"

  quarantiner = system_command(swift,
                               args:         [
                                 QUARANTINE_SCRIPT,
                                 download_path,
                                 cask.url.to_s,
                                 cask.homepage.to_s,
                               ],
                               print_stderr: false)

  return if quarantiner.success?

  case quarantiner.exit_status
  when 2
    raise CaskQuarantineError.new(download_path, "Insufficient parameters")
  else
    raise CaskQuarantineError.new(download_path, quarantiner.stderr)
  end
end

.check_quarantine_supportObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


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
# File 'Library/Homebrew/cask/quarantine.rb', line 28

def check_quarantine_support
  odebug "Checking quarantine support"

  if !system_command(xattr, print_stderr: false).success?
    odebug "There's not a working version of xattr."
    :xattr_broken
  elsif swift.nil?
    odebug "Swift is not available on this system."
    :no_swift
  else
    api_check = system_command(swift,
                               args:         [QUARANTINE_SCRIPT],
                               print_stderr: false)

    case api_check.exit_status
    when 5
      odebug "This feature requires the macOS 10.10 SDK or higher."
      :no_quarantine
    when 2
      odebug "Quarantine is available."
      :quarantine_available
    else
      odebug "Unknown support status"
      :unknown
    end
  end
end

.detect(file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


62
63
64
65
66
67
68
69
70
71
72
# File 'Library/Homebrew/cask/quarantine.rb', line 62

def detect(file)
  return if file.nil?

  odebug "Verifying Gatekeeper status of #{file}"

  quarantine_status = !status(file).empty?

  odebug "#{file} is #{quarantine_status ? "quarantined" : "not quarantined"}"

  quarantine_status
end

.propagate(from: nil, to: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'Library/Homebrew/cask/quarantine.rb', line 136

def propagate(from: nil, to: nil)
  return if from.nil? || to.nil?

  raise CaskError, "#{from} was not quarantined properly." unless detect(from)

  odebug "Propagating quarantine from #{from} to #{to}"

  quarantine_status = toggle_no_translocation_bit(status(from))

  resolved_paths = Pathname.glob(to/"**/*", File::FNM_DOTMATCH).reject(&:symlink?)

  system_command!("/usr/bin/xargs",
                  args:  [
                    "-0",
                    "--",
                    "/bin/chmod",
                    "-h",
                    "u+w",
                  ],
                  input: resolved_paths.join("\0"))

  quarantiner = system_command("/usr/bin/xargs",
                               args:         [
                                 "-0",
                                 "--",
                                 xattr,
                                 "-w",
                                 QUARANTINE_ATTRIBUTE,
                                 quarantine_status,
                               ],
                               input:        resolved_paths.join("\0"),
                               print_stderr: false)

  return if quarantiner.success?

  raise CaskQuarantinePropagationError.new(to, quarantiner.stderr)
end

.release!(download_path: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'Library/Homebrew/cask/quarantine.rb', line 92

def release!(download_path: nil)
  return unless detect(download_path)

  odebug "Releasing #{download_path} from quarantine"

  quarantiner = system_command(xattr,
                               args:         [
                                 "-d",
                                 QUARANTINE_ATTRIBUTE,
                                 download_path,
                               ],
                               print_stderr: false)

  return if quarantiner.success?

  raise CaskQuarantineReleaseError.new(download_path, quarantiner.stderr)
end

.status(file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


74
75
76
77
78
# File 'Library/Homebrew/cask/quarantine.rb', line 74

def status(file)
  system_command(xattr,
                 args:         ["-p", QUARANTINE_ATTRIBUTE, file],
                 print_stderr: false).stdout.rstrip
end

.swiftObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


18
19
20
# File 'Library/Homebrew/cask/quarantine.rb', line 18

def swift
  @swift ||= DevelopmentTools.locate("swift")
end

.toggle_no_translocation_bit(attribute) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


80
81
82
83
84
85
86
87
88
89
90
# File 'Library/Homebrew/cask/quarantine.rb', line 80

def toggle_no_translocation_bit(attribute)
  fields = attribute.split(";")

  # Fields: status, epoch, download agent, event ID
  # Let's toggle the app translocation bit, bit 8
  # http://www.openradar.me/radar?id=5022734169931776

  fields[0] = (fields[0].to_i(16) | 0x0100).to_s(16).rjust(4, "0")

  fields.join(";")
end

.xattrObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


23
24
25
# File 'Library/Homebrew/cask/quarantine.rb', line 23

def xattr
  @xattr ||= DevelopmentTools.locate("xattr")
end