Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

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

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

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

153

154

155

156

157

158

159

160

161

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

"""Tests for certbot.plugins.standalone.""" 

import argparse 

import socket 

import unittest 

# https://github.com/python/typeshed/blob/master/stdlib/2and3/socket.pyi 

from socket import errno as socket_errors # type: ignore 

 

import josepy as jose 

import mock 

import six 

 

import OpenSSL.crypto # pylint: disable=unused-import 

 

from acme import challenges 

from acme import standalone as acme_standalone # pylint: disable=unused-import 

from acme.magic_typing import Dict, Tuple, Set # pylint: disable=unused-import, no-name-in-module 

 

from certbot import achallenges 

from certbot import errors 

 

from certbot.tests import acme_util 

from certbot.tests import util as test_util 

 

 

class ServerManagerTest(unittest.TestCase): 

"""Tests for certbot.plugins.standalone.ServerManager.""" 

 

def setUp(self): 

from certbot.plugins.standalone import ServerManager 

self.certs = {} # type: Dict[bytes, Tuple[OpenSSL.crypto.PKey, OpenSSL.crypto.X509]] 

self.http_01_resources = {} \ 

# type: Set[acme_standalone.HTTP01RequestHandler.HTTP01Resource] 

self.mgr = ServerManager(self.certs, self.http_01_resources) 

 

def test_init(self): 

self.assertTrue(self.mgr.certs is self.certs) 

self.assertTrue( 

self.mgr.http_01_resources is self.http_01_resources) 

 

def _test_run_stop(self, challenge_type): 

server = self.mgr.run(port=0, challenge_type=challenge_type) 

port = server.getsocknames()[0][1] # pylint: disable=no-member 

self.assertEqual(self.mgr.running(), {port: server}) 

self.mgr.stop(port=port) 

self.assertEqual(self.mgr.running(), {}) 

 

def test_run_stop_tls_sni_01(self): 

self._test_run_stop(challenges.TLSSNI01) 

 

def test_run_stop_http_01(self): 

self._test_run_stop(challenges.HTTP01) 

 

def test_run_idempotent(self): 

server = self.mgr.run(port=0, challenge_type=challenges.HTTP01) 

port = server.getsocknames()[0][1] # pylint: disable=no-member 

server2 = self.mgr.run(port=port, challenge_type=challenges.HTTP01) 

self.assertEqual(self.mgr.running(), {port: server}) 

self.assertTrue(server is server2) 

self.mgr.stop(port) 

self.assertEqual(self.mgr.running(), {}) 

 

def test_run_bind_error(self): 

some_server = socket.socket(socket.AF_INET6) 

some_server.bind(("", 0)) 

port = some_server.getsockname()[1] 

maybe_another_server = socket.socket() 

try: 

maybe_another_server.bind(("", port)) 

except socket.error: 

pass 

self.assertRaises( 

errors.StandaloneBindError, self.mgr.run, port, 

challenge_type=challenges.HTTP01) 

self.assertEqual(self.mgr.running(), {}) 

some_server.close() 

maybe_another_server.close() 

 

 

class SupportedChallengesActionTest(unittest.TestCase): 

"""Tests for plugins.standalone.SupportedChallengesAction.""" 

 

def _call(self, value): 

with mock.patch("certbot.plugins.standalone.logger") as mock_logger: 

# stderr is mocked to prevent potential argparse error 

# output from cluttering test output 

with mock.patch("sys.stderr"): 

config = self.parser.parse_args([self.flag, value]) 

 

self.assertTrue(mock_logger.warning.called) 

return getattr(config, self.dest) 

 

def setUp(self): 

self.flag = "--standalone-supported-challenges" 

self.dest = self.flag[2:].replace("-", "_") 

self.parser = argparse.ArgumentParser() 

 

from certbot.plugins.standalone import SupportedChallengesAction 

self.parser.add_argument(self.flag, action=SupportedChallengesAction) 

 

def test_correct(self): 

self.assertEqual("tls-sni-01", self._call("tls-sni-01")) 

self.assertEqual("http-01", self._call("http-01")) 

self.assertEqual("tls-sni-01,http-01", self._call("tls-sni-01,http-01")) 

self.assertEqual("http-01,tls-sni-01", self._call("http-01,tls-sni-01")) 

 

def test_unrecognized(self): 

assert "foo" not in challenges.Challenge.TYPES 

self.assertRaises(SystemExit, self._call, "foo") 

 

def test_not_subset(self): 

self.assertRaises(SystemExit, self._call, "dns") 

 

def test_dvsni(self): 

self.assertEqual("tls-sni-01", self._call("dvsni")) 

self.assertEqual("http-01,tls-sni-01", self._call("http-01,dvsni")) 

self.assertEqual("tls-sni-01,http-01", self._call("dvsni,http-01")) 

 

 

def get_open_port(): 

"""Gets an open port number from the OS.""" 

open_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) 

open_socket.bind(("", 0)) 

port = open_socket.getsockname()[1] 

open_socket.close() 

return port 

 

 

class AuthenticatorTest(unittest.TestCase): 

"""Tests for certbot.plugins.standalone.Authenticator.""" 

 

def setUp(self): 

from certbot.plugins.standalone import Authenticator 

 

self.config = mock.MagicMock( 

tls_sni_01_port=get_open_port(), http01_port=get_open_port(), 

standalone_supported_challenges="tls-sni-01,http-01") 

self.auth = Authenticator(self.config, name="standalone") 

self.auth.servers = mock.MagicMock() 

 

def test_supported_challenges(self): 

self.assertEqual(self.auth.supported_challenges, 

[challenges.TLSSNI01, challenges.HTTP01]) 

 

def test_supported_challenges_configured(self): 

self.config.standalone_supported_challenges = "tls-sni-01" 

self.assertEqual(self.auth.supported_challenges, 

[challenges.TLSSNI01]) 

 

def test_more_info(self): 

self.assertTrue(isinstance(self.auth.more_info(), six.string_types)) 

 

def test_get_chall_pref(self): 

self.assertEqual(self.auth.get_chall_pref(domain=None), 

[challenges.TLSSNI01, challenges.HTTP01]) 

 

def test_get_chall_pref_configured(self): 

self.config.standalone_supported_challenges = "tls-sni-01" 

self.assertEqual(self.auth.get_chall_pref(domain=None), 

[challenges.TLSSNI01]) 

 

def test_perform(self): 

achalls = self._get_achalls() 

response = self.auth.perform(achalls) 

 

expected = [achall.response(achall.account_key) for achall in achalls] 

self.assertEqual(response, expected) 

 

@test_util.patch_get_utility() 

def test_perform_eaddrinuse_retry(self, mock_get_utility): 

mock_utility = mock_get_utility() 

errno = socket_errors.EADDRINUSE 

error = errors.StandaloneBindError(mock.MagicMock(errno=errno), -1) 

self.auth.servers.run.side_effect = [error] + 2 * [mock.MagicMock()] 

mock_yesno = mock_utility.yesno 

mock_yesno.return_value = True 

 

self.test_perform() 

self._assert_correct_yesno_call(mock_yesno) 

 

@test_util.patch_get_utility() 

def test_perform_eaddrinuse_no_retry(self, mock_get_utility): 

mock_utility = mock_get_utility() 

mock_yesno = mock_utility.yesno 

mock_yesno.return_value = False 

 

errno = socket_errors.EADDRINUSE 

self.assertRaises(errors.PluginError, self._fail_perform, errno) 

self._assert_correct_yesno_call(mock_yesno) 

 

def _assert_correct_yesno_call(self, mock_yesno): 

yesno_args, yesno_kwargs = mock_yesno.call_args 

self.assertTrue("in use" in yesno_args[0]) 

self.assertFalse(yesno_kwargs.get("default", True)) 

 

def test_perform_eacces(self): 

errno = socket_errors.EACCES 

self.assertRaises(errors.PluginError, self._fail_perform, errno) 

 

def test_perform_unexpected_socket_error(self): 

errno = socket_errors.ENOTCONN 

self.assertRaises( 

errors.StandaloneBindError, self._fail_perform, errno) 

 

def _fail_perform(self, errno): 

error = errors.StandaloneBindError(mock.MagicMock(errno=errno), -1) 

self.auth.servers.run.side_effect = error 

self.auth.perform(self._get_achalls()) 

 

@classmethod 

def _get_achalls(cls): 

domain = b'localhost' 

key = jose.JWK.load(test_util.load_vector('rsa512_key.pem')) 

http_01 = achallenges.KeyAuthorizationAnnotatedChallenge( 

challb=acme_util.HTTP01_P, domain=domain, account_key=key) 

tls_sni_01 = achallenges.KeyAuthorizationAnnotatedChallenge( 

challb=acme_util.TLSSNI01_P, domain=domain, account_key=key) 

 

return [http_01, tls_sni_01] 

 

def test_cleanup(self): 

self.auth.servers.running.return_value = { 

1: "server1", 

2: "server2", 

} 

self.auth.served["server1"].add("chall1") 

self.auth.served["server2"].update(["chall2", "chall3"]) 

 

self.auth.cleanup(["chall1"]) 

self.assertEqual(self.auth.served, { 

"server1": set(), "server2": set(["chall2", "chall3"])}) 

self.auth.servers.stop.assert_called_once_with(1) 

 

self.auth.servers.running.return_value = { 

2: "server2", 

} 

self.auth.cleanup(["chall2"]) 

self.assertEqual(self.auth.served, { 

"server1": set(), "server2": set(["chall3"])}) 

self.assertEqual(1, self.auth.servers.stop.call_count) 

 

self.auth.cleanup(["chall3"]) 

self.assertEqual(self.auth.served, { 

"server1": set(), "server2": set([])}) 

self.auth.servers.stop.assert_called_with(2) 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover