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

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

"""Tests for certbot.account.""" 

import datetime 

import json 

import os 

import shutil 

import stat 

import unittest 

 

import josepy as jose 

import mock 

import pytz 

 

from acme import messages 

 

from certbot import compat 

from certbot import errors 

 

import certbot.tests.util as test_util 

 

 

KEY = jose.JWKRSA.load(test_util.load_vector("rsa512_key.pem")) 

 

 

class AccountTest(unittest.TestCase): 

"""Tests for certbot.account.Account.""" 

 

def setUp(self): 

from certbot.account import Account 

self.regr = mock.MagicMock() 

self.meta = Account.Meta( 

creation_host="test.certbot.org", 

creation_dt=datetime.datetime( 

2015, 7, 4, 14, 4, 10, tzinfo=pytz.UTC)) 

self.acc = Account(self.regr, KEY, self.meta) 

self.regr.__repr__ = mock.MagicMock(return_value="i_am_a_regr") 

 

with mock.patch("certbot.account.socket") as mock_socket: 

mock_socket.getfqdn.return_value = "test.certbot.org" 

with mock.patch("certbot.account.datetime") as mock_dt: 

mock_dt.datetime.now.return_value = self.meta.creation_dt 

self.acc_no_meta = Account(self.regr, KEY) 

 

def test_init(self): 

self.assertEqual(self.regr, self.acc.regr) 

self.assertEqual(KEY, self.acc.key) 

self.assertEqual(self.meta, self.acc_no_meta.meta) 

 

def test_id(self): 

self.assertEqual( 

self.acc.id, "7adac10320f585ddf118429c0c4af2cd") 

 

def test_slug(self): 

self.assertEqual( 

self.acc.slug, "test.certbot.org@2015-07-04T14:04:10Z (7ada)") 

 

def test_repr(self): 

self.assertTrue(repr(self.acc).startswith( 

"<Account(i_am_a_regr, 7adac10320f585ddf118429c0c4af2cd, Meta(")) 

 

class ReportNewAccountTest(test_util.ConfigTestCase): 

"""Tests for certbot.account.report_new_account.""" 

 

def _call(self): 

from certbot.account import report_new_account 

report_new_account(self.config) 

 

@mock.patch("certbot.account.zope.component.queryUtility") 

def test_no_reporter(self, mock_zope): 

mock_zope.return_value = None 

self._call() 

 

@mock.patch("certbot.account.zope.component.queryUtility") 

def test_it(self, mock_zope): 

self._call() 

call_list = mock_zope().add_message.call_args_list 

self.assertTrue(self.config.config_dir in call_list[0][0][0]) 

 

 

class AccountMemoryStorageTest(unittest.TestCase): 

"""Tests for certbot.account.AccountMemoryStorage.""" 

 

def setUp(self): 

from certbot.account import AccountMemoryStorage 

self.storage = AccountMemoryStorage() 

 

def test_it(self): 

account = mock.Mock(id="x") 

self.assertEqual([], self.storage.find_all()) 

self.assertRaises(errors.AccountNotFound, self.storage.load, "x") 

self.storage.save(account, None) 

self.assertEqual([account], self.storage.find_all()) 

self.assertEqual(account, self.storage.load("x")) 

self.storage.save(account, None) 

self.assertEqual([account], self.storage.find_all()) 

 

 

class AccountFileStorageTest(test_util.ConfigTestCase): 

"""Tests for certbot.account.AccountFileStorage.""" 

#pylint: disable=too-many-public-methods 

 

def setUp(self): 

super(AccountFileStorageTest, self).setUp() 

 

from certbot.account import AccountFileStorage 

self.storage = AccountFileStorage(self.config) 

 

from certbot.account import Account 

new_authzr_uri = "hi" 

self.acc = Account( 

regr=messages.RegistrationResource( 

uri=None, body=messages.Registration(), 

new_authzr_uri=new_authzr_uri), 

key=KEY) 

self.mock_client = mock.MagicMock() 

self.mock_client.directory.new_authz = new_authzr_uri 

 

def test_init_creates_dir(self): 

self.assertTrue(os.path.isdir( 

compat.underscores_for_unsupported_characters_in_path(self.config.accounts_dir))) 

 

@test_util.broken_on_windows 

def test_save_and_restore(self): 

self.storage.save(self.acc, self.mock_client) 

account_path = os.path.join(self.config.accounts_dir, self.acc.id) 

self.assertTrue(os.path.exists(account_path)) 

for file_name in "regr.json", "meta.json", "private_key.json": 

self.assertTrue(os.path.exists( 

os.path.join(account_path, file_name))) 

self.assertTrue(oct(os.stat(os.path.join( 

account_path, "private_key.json"))[stat.ST_MODE] & 0o777) in ("0400", "0o400")) 

 

# restore 

loaded = self.storage.load(self.acc.id) 

self.assertEqual(self.acc, loaded) 

 

def test_save_and_restore_old_version(self): 

"""Saved regr should include a new_authzr_uri for older Certbots""" 

self.storage.save(self.acc, self.mock_client) 

path = os.path.join(self.config.accounts_dir, self.acc.id, "regr.json") 

with open(path, "r") as f: 

regr = json.load(f) 

self.assertTrue("new_authzr_uri" in regr) 

 

def test_save_regr(self): 

self.storage.save_regr(self.acc, self.mock_client) 

account_path = os.path.join(self.config.accounts_dir, self.acc.id) 

self.assertTrue(os.path.exists(account_path)) 

self.assertTrue(os.path.exists(os.path.join( 

account_path, "regr.json"))) 

for file_name in "meta.json", "private_key.json": 

self.assertFalse(os.path.exists( 

os.path.join(account_path, file_name))) 

 

def test_find_all(self): 

self.storage.save(self.acc, self.mock_client) 

self.assertEqual([self.acc], self.storage.find_all()) 

 

def test_find_all_none_empty_list(self): 

self.assertEqual([], self.storage.find_all()) 

 

def test_find_all_accounts_dir_absent(self): 

os.rmdir(self.config.accounts_dir) 

self.assertEqual([], self.storage.find_all()) 

 

def test_find_all_load_skips(self): 

# pylint: disable=protected-access 

self.storage._load_for_server_path = mock.MagicMock( 

side_effect=["x", errors.AccountStorageError, "z"]) 

with mock.patch("certbot.account.os.listdir") as mock_listdir: 

mock_listdir.return_value = ["x", "y", "z"] 

self.assertEqual(["x", "z"], self.storage.find_all()) 

 

def test_load_non_existent_raises_error(self): 

self.assertRaises(errors.AccountNotFound, self.storage.load, "missing") 

 

def test_load_id_mismatch_raises_error(self): 

self.storage.save(self.acc, self.mock_client) 

shutil.move(os.path.join(self.config.accounts_dir, self.acc.id), 

os.path.join(self.config.accounts_dir, "x" + self.acc.id)) 

self.assertRaises(errors.AccountStorageError, self.storage.load, 

"x" + self.acc.id) 

 

def _set_server(self, server): 

self.config.server = server 

from certbot.account import AccountFileStorage 

self.storage = AccountFileStorage(self.config) 

 

def test_find_all_neither_exists(self): 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertEqual([], self.storage.find_all()) 

self.assertEqual([], self.storage.find_all()) 

self.assertFalse(os.path.islink(self.config.accounts_dir)) 

 

def test_find_all_find_before_save(self): 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertEqual([], self.storage.find_all()) 

self.storage.save(self.acc, self.mock_client) 

self.assertEqual([self.acc], self.storage.find_all()) 

self.assertEqual([self.acc], self.storage.find_all()) 

self.assertFalse(os.path.islink(self.config.accounts_dir)) 

# we shouldn't have created a v1 account 

prev_server_path = 'https://acme-staging.api.letsencrypt.org/directory' 

self.assertFalse(os.path.isdir(self.config.accounts_dir_for_server_path(prev_server_path))) 

 

def test_find_all_save_before_find(self): 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

self.assertEqual([self.acc], self.storage.find_all()) 

self.assertEqual([self.acc], self.storage.find_all()) 

self.assertFalse(os.path.islink(self.config.accounts_dir)) 

self.assertTrue(os.path.isdir(self.config.accounts_dir)) 

prev_server_path = 'https://acme-staging.api.letsencrypt.org/directory' 

self.assertFalse(os.path.isdir(self.config.accounts_dir_for_server_path(prev_server_path))) 

 

def test_find_all_server_downgrade(self): 

# don't use v2 accounts with a v1 url 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertEqual([], self.storage.find_all()) 

self.storage.save(self.acc, self.mock_client) 

self.assertEqual([self.acc], self.storage.find_all()) 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.assertEqual([], self.storage.find_all()) 

 

@test_util.broken_on_windows 

def test_upgrade_version_staging(self): 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertEqual([self.acc], self.storage.find_all()) 

 

@test_util.broken_on_windows 

def test_upgrade_version_production(self): 

self._set_server('https://acme-v01.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

self._set_server('https://acme-v02.api.letsencrypt.org/directory') 

self.assertEqual([self.acc], self.storage.find_all()) 

 

@mock.patch('os.rmdir') 

def test_corrupted_account(self, mock_rmdir): 

# pylint: disable=protected-access 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

mock_rmdir.side_effect = OSError 

self.storage._load_for_server_path = mock.MagicMock( 

side_effect=errors.AccountStorageError) 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertEqual([], self.storage.find_all()) 

 

@test_util.broken_on_windows 

def test_upgrade_load(self): 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

prev_account = self.storage.load(self.acc.id) 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

account = self.storage.load(self.acc.id) 

self.assertEqual(prev_account, account) 

 

@test_util.broken_on_windows 

def test_upgrade_load_single_account(self): 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

prev_account = self.storage.load(self.acc.id) 

self._set_server_and_stop_symlink('https://acme-staging-v02.api.letsencrypt.org/directory') 

account = self.storage.load(self.acc.id) 

self.assertEqual(prev_account, account) 

 

def test_load_ioerror(self): 

self.storage.save(self.acc, self.mock_client) 

mock_open = mock.mock_open() 

mock_open.side_effect = IOError 

with mock.patch("six.moves.builtins.open", mock_open): 

self.assertRaises( 

errors.AccountStorageError, self.storage.load, self.acc.id) 

 

def test_save_ioerrors(self): 

mock_open = mock.mock_open() 

mock_open.side_effect = IOError # TODO: [None, None, IOError] 

with mock.patch("six.moves.builtins.open", mock_open): 

self.assertRaises( 

errors.AccountStorageError, self.storage.save, 

self.acc, self.mock_client) 

 

@test_util.broken_on_windows 

def test_delete(self): 

self.storage.save(self.acc, self.mock_client) 

self.storage.delete(self.acc.id) 

self.assertRaises(errors.AccountNotFound, self.storage.load, self.acc.id) 

 

def test_delete_no_account(self): 

self.assertRaises(errors.AccountNotFound, self.storage.delete, self.acc.id) 

 

def _assert_symlinked_account_removed(self): 

# create v1 account 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

# ensure v2 isn't already linked to it 

with mock.patch('certbot.constants.LE_REUSE_SERVERS', {}): 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertRaises(errors.AccountNotFound, self.storage.load, self.acc.id) 

 

def _test_delete_folders(self, server_url): 

# create symlinked servers 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.storage.save(self.acc, self.mock_client) 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.storage.load(self.acc.id) 

 

# delete starting at given server_url 

self._set_server(server_url) 

self.storage.delete(self.acc.id) 

 

# make sure we're gone from both urls 

self._set_server('https://acme-staging.api.letsencrypt.org/directory') 

self.assertRaises(errors.AccountNotFound, self.storage.load, self.acc.id) 

self._set_server('https://acme-staging-v02.api.letsencrypt.org/directory') 

self.assertRaises(errors.AccountNotFound, self.storage.load, self.acc.id) 

 

@test_util.broken_on_windows 

def test_delete_folders_up(self): 

self._test_delete_folders('https://acme-staging.api.letsencrypt.org/directory') 

self._assert_symlinked_account_removed() 

 

@test_util.broken_on_windows 

def test_delete_folders_down(self): 

self._test_delete_folders('https://acme-staging-v02.api.letsencrypt.org/directory') 

self._assert_symlinked_account_removed() 

 

def _set_server_and_stop_symlink(self, server_path): 

self._set_server(server_path) 

with open(os.path.join(self.config.accounts_dir, 'foo'), 'w') as f: 

f.write('bar') 

 

@test_util.broken_on_windows 

def test_delete_shared_account_up(self): 

self._set_server_and_stop_symlink('https://acme-staging-v02.api.letsencrypt.org/directory') 

self._test_delete_folders('https://acme-staging.api.letsencrypt.org/directory') 

 

@test_util.broken_on_windows 

def test_delete_shared_account_down(self): 

self._set_server_and_stop_symlink('https://acme-staging-v02.api.letsencrypt.org/directory') 

self._test_delete_folders('https://acme-staging-v02.api.letsencrypt.org/directory') 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover