JWTConnect-Python-CryptoJWT/src/cryptojwt/utils.py at main · IdentityPython/JWTConnect-Python-CryptoJWT · GitHub

Repository navigation

History

359 lines (259 loc) · 8.6 KB

Raw

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

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

import base64

import contextlib

import functools

import importlib

import json

import re

import struct

import warnings

from binascii import unhexlify

from email.message import EmailMessage

from cryptojwt.exception import BadSyntax

DEFAULT_HTTPC_TIMEOUT = 10

# ---------------------------------------------------------------------------

# Helper functions

def intarr2bin(arr):

return unhexlify("".join([f"{byte:02x}" for byte in arr]))

def intarr2long(arr):

return int("".join([f"{byte:02x}" for byte in arr]), 16)

def intarr2str(arr):

return "".join([chr(c) for c in arr])

def long2intarr(long_int):

_bytes: list[int] = []

while long_int:

long_int, r = divmod(long_int, 256)

_bytes.insert(0, r)

return _bytes

def long_to_base64(n, mlen=0):

bys = long2intarr(n)

if mlen:

_len = mlen - len(bys)

if _len:

bys = [0] * _len + bys

data = struct.pack(f"{len(bys)}B", *bys)

if not len(data):

data = b"\x00"

s = base64.urlsafe_b64encode(data).rstrip(b"=")

return s.decode("ascii")

def base64_to_long(data):

if isinstance(data, str):

data = data.encode("ascii")

# urlsafe_b64decode will happily convert b64encoded data

_d = base64.urlsafe_b64decode(as_bytes(data) + b"==")

return intarr2long(struct.unpack(f"{len(_d)}B", _d))

def base64url_to_long(data):

"""

Stricter then base64_to_long since it really checks that it's

base64url encoded

:param data: The base64 string

:return:

"""

_data = as_bytes(data)

_d = base64.urlsafe_b64decode(_data + b"==")

# verify that it's base64url encoded and not just base64

# that is no '+' and '/' characters and not trailing "="s.

if [e for e in [b"+", b"/", b"="] if e in _data]:

raise ValueError("Not base64url encoded")

return intarr2long(struct.unpack(f"{len(_d)}B", _d))

# =============================================================================

def b64e(b):

"""Base64 encode some bytes.

Uses the url-safe - and _ characters, and doesn't pad with = characters."""

return base64.urlsafe_b64encode(b).rstrip(b"=")

_b64_re = re.compile(b"^[A-Za-z0-9_-]*$")

def add_padding(b):

# add padding chars

m = len(b) % 4

if m == 1:

# NOTE: for some reason b64decode raises *TypeError* if the

# padding is incorrect.

raise BadSyntax(b, "incorrect padding")

elif m == 2:

b += b"=="

elif m == 3:

b += b"="

return b

def b64d(b):

"""Decode some base64-encoded bytes.

Raises BadSyntax if the string contains invalid characters or padding.

:param b: bytes

"""

cb = b.rstrip(b"=") # shouldn't but there you are

# Python's base64 functions ignore invalid characters, so we need to

# check for them explicitly.

if not _b64_re.match(cb):

raise BadSyntax(cb, "base64-encoded data contains illegal characters")

if cb == b:

b = add_padding(b)

return base64.urlsafe_b64decode(b)

def b64e_enc_dec(datastr, encode="utf-8", decode="ascii"):

return b64e(datastr.encode(encode)).decode(decode)

def b64d_enc_dec(datastr, encode="ascii", decode="utf-8"):

return b64d(datastr.encode(encode)).decode(decode)

def as_bytes(s):

"""

Convert an unicode string to bytes.

:param s: Unicode / bytes string

:return: bytes string

"""

with contextlib.suppress(AttributeError, UnicodeDecodeError):

s = s.encode()

return s

def as_unicode(b):

"""

Convert a byte string to a unicode string

:param b: byte string

:return: unicode string

"""

with contextlib.suppress(AttributeError, UnicodeDecodeError):

b = b.decode()

return b

def bytes2str_conv(item):

""""""

if isinstance(item, bytes):

return item.decode("utf-8")

elif item is None or isinstance(item, (str, int, bool)):

return item

elif isinstance(item, list):

return [bytes2str_conv(i) for i in item]

elif isinstance(item, dict):

return dict([(k, bytes2str_conv(v)) for k, v in item.items()])

raise ValueError(f"Can't convert {repr(item)}.")

def b64encode_item(item):

if isinstance(item, bytes):

return b64e(item)

elif isinstance(item, str):

return b64e(item.encode("utf-8"))

elif isinstance(item, int):

return b64e(item)

else:

return b64e(json.dumps(bytes2str_conv(item), separators=(",", ":")).encode("utf-8"))

def split_token(token):

if not token.count(b"."):

raise BadSyntax(token, "expected token to contain at least one dot")

return tuple(token.split(b"."))

def deser(val):

"""

Deserialize from a string representation of a long integer

to the python representation of a long integer.

:param val: The string representation of the long integer.

:return: The long integer.

"""

_val = val.encode("utf-8") if isinstance(val, str) else val

return base64_to_long(_val)

def modsplit(name):

"""Split importable"""

if ":" in name:

_part = name.split(":")

if len(_part) != 2:

raise ValueError(f"Syntax error: {name}")

return _part[0], _part[1]

_part = name.split(".")

if len(_part) < 2:

raise ValueError(f"Syntax error: {name}")

return ".".join(_part[:-1]), _part[-1]

def importer(name):

"""Import by name"""

_part = modsplit(name)

module = importlib.import_module(_part[0])

return getattr(module, _part[1])

def qualified_name(cls):

return cls.__module__ + "." + cls.__name__

# This is borrowed from

# https://stackoverflow.com/questions/49802412/how-to-implement-deprecation-in-python-with

# -argument-alias

# cudos to https://stackoverflow.com/users/2357112/user2357112-supports-monica

def deprecated_alias(**aliases):

def deco(f):

@functools.wraps(f)

def wrapper(*args, **kwargs):

rename_kwargs(f.__name__, kwargs, aliases)

return f(*args, **kwargs)

return wrapper

return deco

def rename_kwargs(func_name, kwargs, aliases):

for alias, new in aliases.items():

if alias in kwargs:

if new in kwargs:

raise TypeError(f"{func_name} received both {alias} and {new}")

warnings.warn(f"{alias} is deprecated; use {new}", DeprecationWarning, stacklevel=1)

kwargs[new] = kwargs.pop(alias)

def httpc_params_loader(httpc_params):

httpc_params = httpc_params or {}

if "timeout" not in httpc_params:

httpc_params["timeout"] = DEFAULT_HTTPC_TIMEOUT

return httpc_params

def check_content_type(content_type: str, mime_type: str | list[str] | set[str]):

"""Return True if the content type contains the MIME type"""

msg = EmailMessage()

msg["content-type"] = content_type

mt = msg.get_content_type()

if isinstance(mime_type, str):

return mt == mime_type

elif isinstance(mime_type, (list, set)):

return mt in mime_type

else:

raise ValueError("Invalid MIME type argument")

def is_compact_jws(token):

token = as_bytes(token)

try:

part = split_token(token)

except BadSyntax:

return False

# Should be three parts

if len(part) != 3:

return False

# All base64 encoded

try:

part = [b64d(p) for p in part]

except Exception:

return False

# header should be a JSON object, 'alg' most be one parameter

try:

_header = json.loads(part[0])

except Exception:

return False

return "alg" in _header

def is_jwe(token):

token = as_bytes(token)

try:

part = split_token(token)

except BadSyntax:

return False

# Should be five parts

if len(part) != 5:

return False

# All base64 encoded

try:

part = [b64d(p) for p in part]

except Exception:

return False

# header should be a JSON object, 'alg' most be one parameter

try:

_header = json.loads(part[0])

except Exception:

return False

return not ("alg" not in _header or "enc" not in _header)

def is_json_jws(token):

if isinstance(token, str):

try:

token = json.loads(token)

except Exception:

return False

for arg in ["payload", "signatures"]:

if arg not in token:

return False

if not isinstance(token["signatures"], list):

return False

for sign in token["signatures"]:

if not isinstance(sign, dict):

return False

if "signature" not in sign:

return False

return True

def is_jws(token):

if is_json_jws(token):

return "json"

elif is_compact_jws(token):

return "compact"

return False

JWTConnect-Python-CryptoJWT/src/cryptojwt/utils.py at main · IdentityPython/JWTConnect-Python-CryptoJWT · GitHub

Repository navigation

Expand file tree

Breadcrumbs

utils.py

Latest commit

History

Breadcrumbs

utils.py

File metadata and controls