Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add script to regenerate JWKs for LMS asymmetric JWT signing #32025

Closed
wants to merge 2 commits into from
Closed

feat: Add script to regenerate JWKs for LMS asymmetric JWT signing #32025

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
473e6dd
feat: Add script to regenerate JWKs for LMS asymmetric JWT signing
timmc-edx Apr 3, 2023
52516c8
fixup! Remove commented out code, fix lint
timmc-edx Apr 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 15 additions & 21 deletions cms/envs/devstack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,27 +188,21 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing
}],
'JWT_SECRET_KEY': 'lms-secret',
'JWT_AUDIENCE': 'lms-key',
'JWT_PUBLIC_SIGNING_JWK_SET': (
'{"keys": [{"kid": "devstack_key", "e": "AQAB", "kty": "RSA", "n": "smKFSYowG6nNUAdeqH1jQQnH1PmIHphzBmwJ5vRf1vu'
'48BUI5VcVtUWIPqzRK_LDSlZYh9D0YFL0ZTxIrlb6Tn3Xz7pYvpIAeYuQv3_H5p8tbz7Fb8r63c1828wXPITVTv8f7oxx5W3lFFgpFAyYMmROC'
'4Ee9qG5T38LFe8_oAuFCEntimWxN9F3P-FJQy43TL7wG54WodgiM0EgzkeLr5K6cDnyckWjTuZbWI-4ffcTgTZsL_Kq1owa_J2ngEfxMCObnzG'
'y5ZLcTUomo4rZLjghVpq6KZxfS6I1Vz79ZsMVUWEdXOYePCKKsrQG20ogQEkmTf9FT_SouC6jPcHLXw"}]}'
),

# TODO Remove this once CMS redirects to LMS for Login
'JWT_PRIVATE_SIGNING_JWK': (
'{"e": "AQAB", "d": "RQ6k4NpRU3RB2lhwCbQ452W86bMMQiPsa7EJiFJUg-qBJthN0FMNQVbArtrCQ0xA1BdnQHThFiUnHcXfsTZUwmwvTu'
'iqEGR_MI6aI7h5D8vRj_5x-pxOz-0MCB8TY8dcuK9FkljmgtYvV9flVzCk_uUb3ZJIBVyIW8En7n7nV7JXpS9zey1yVLld2AbRG6W5--Pgqr9J'
'CI5-bLdc2otCLuen2sKyuUDHO5NIj30qGTaKUL-OW_PgVmxrwKwccF3w5uGNEvMQ-IcicosCOvzBwdIm1uhdm9rnHU1-fXz8VLRHNhGVv7z6mo'
'ghjNI0_u4smhUkEsYeshPv7RQEWTdkOQ", "n": "smKFSYowG6nNUAdeqH1jQQnH1PmIHphzBmwJ5vRf1vu48BUI5VcVtUWIPqzRK_LDSlZYh'
'9D0YFL0ZTxIrlb6Tn3Xz7pYvpIAeYuQv3_H5p8tbz7Fb8r63c1828wXPITVTv8f7oxx5W3lFFgpFAyYMmROC4Ee9qG5T38LFe8_oAuFCEntimW'
'xN9F3P-FJQy43TL7wG54WodgiM0EgzkeLr5K6cDnyckWjTuZbWI-4ffcTgTZsL_Kq1owa_J2ngEfxMCObnzGy5ZLcTUomo4rZLjghVpq6KZxfS'
'6I1Vz79ZsMVUWEdXOYePCKKsrQG20ogQEkmTf9FT_SouC6jPcHLXw", "q": "7KWj7l-ZkfCElyfvwsl7kiosvi-ppOO7Imsv90cribf88Dex'
'cO67xdMPesjM9Nh5X209IT-TzbsOtVTXSQyEsy42NY72WETnd1_nAGLAmfxGdo8VV4ZDnRsA8N8POnWjRDwYlVBUEEeuT_MtMWzwIKU94bzkWV'
'nHCY5vbhBYLeM", "p": "wPkfnjavNV1Hqb5Qqj2crBS9HQS6GDQIZ7WF9hlBb2ofDNe2K2dunddFqCOdvLXr7ydRcK51ZwSeHjcjgD1aJkHA'
'9i1zqyboxgd0uAbxVDo6ohnlVqYLtap2tXXcavKm4C9MTpob_rk6FBfEuq4uSsuxFvCER4yG3CYBBa4gZVU", "kid": "devstack_key", "'
'kty": "RSA"}'
),
'JWT_PUBLIC_SIGNING_JWK_SET': """
{
"keys": [
{
"e": "AQAB",
"key_ops": [
"verify"
],
"kid": "devstack_key",
"kty": "RSA",
"n": "ptX-wylRklr_xX5YQpYaVMW8vMx-Y1miaGLZAQxeL_TsqNWn40MMMxT2b2dFBTwOIXwgwnoNvZj3vASMpe2TVNyOZvr52QG1vveOiXeGlB5sIelI_qsWKfJlc9K949FS2tdof9xM3mKQDDVj9Bw3B8a9kr8lHfMV6XKnajxnrnsAEZF8o_-9juh6rJKaJXcnBLDHhqmfNiIxqr9Q37rc7eMI3LspZngoIr1zg_mU4PEzMkjIVnpQbsgV_Y_YiYvG-xUbHVg2KhR7wI12u0bzjfLRJ8CoFfSrl1bHZ8iP0eXbSP2x7fCz1J0HagAqWCSiGCbYf-HmypoxTdUzIgj8EQ"
}
]
}
""",
})

# pylint: enable=unicode-format-string # lint-amnesty, pylint: disable=bad-option-value
Expand Down
1 change: 1 addition & 0 deletions lms/envs/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4376,6 +4376,7 @@ def _make_locale_paths(settings): # pylint: disable=missing-function-docstring
'JWT_SECRET_KEY': SECRET_KEY,

'JWT_SIGNING_ALGORITHM': 'RS512',
# Use scripts/generate-jwt-keys.py to generate these.
'JWT_PRIVATE_SIGNING_JWK': None,
'JWT_PUBLIC_SIGNING_JWK_SET': None,

Expand Down
52 changes: 33 additions & 19 deletions lms/envs/devstack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,25 +320,39 @@ def should_show_debug_toolbar(request): # lint-amnesty, pylint: disable=missing
}],
'JWT_SECRET_KEY': 'lms-secret',
'JWT_SIGNING_ALGORITHM': 'RS512',
'JWT_PRIVATE_SIGNING_JWK': (
'{"e": "AQAB", "d": "RQ6k4NpRU3RB2lhwCbQ452W86bMMQiPsa7EJiFJUg-qBJthN0FMNQVbArtrCQ0xA1BdnQHThFiUnHcXfsTZUwmwvTu'
'iqEGR_MI6aI7h5D8vRj_5x-pxOz-0MCB8TY8dcuK9FkljmgtYvV9flVzCk_uUb3ZJIBVyIW8En7n7nV7JXpS9zey1yVLld2AbRG6W5--Pgqr9J'
'CI5-bLdc2otCLuen2sKyuUDHO5NIj30qGTaKUL-OW_PgVmxrwKwccF3w5uGNEvMQ-IcicosCOvzBwdIm1uhdm9rnHU1-fXz8VLRHNhGVv7z6mo'
'ghjNI0_u4smhUkEsYeshPv7RQEWTdkOQ", "n": "smKFSYowG6nNUAdeqH1jQQnH1PmIHphzBmwJ5vRf1vu48BUI5VcVtUWIPqzRK_LDSlZYh'
'9D0YFL0ZTxIrlb6Tn3Xz7pYvpIAeYuQv3_H5p8tbz7Fb8r63c1828wXPITVTv8f7oxx5W3lFFgpFAyYMmROC4Ee9qG5T38LFe8_oAuFCEntimW'
'xN9F3P-FJQy43TL7wG54WodgiM0EgzkeLr5K6cDnyckWjTuZbWI-4ffcTgTZsL_Kq1owa_J2ngEfxMCObnzGy5ZLcTUomo4rZLjghVpq6KZxfS'
'6I1Vz79ZsMVUWEdXOYePCKKsrQG20ogQEkmTf9FT_SouC6jPcHLXw", "q": "7KWj7l-ZkfCElyfvwsl7kiosvi-ppOO7Imsv90cribf88Dex'
'cO67xdMPesjM9Nh5X209IT-TzbsOtVTXSQyEsy42NY72WETnd1_nAGLAmfxGdo8VV4ZDnRsA8N8POnWjRDwYlVBUEEeuT_MtMWzwIKU94bzkWV'
'nHCY5vbhBYLeM", "p": "wPkfnjavNV1Hqb5Qqj2crBS9HQS6GDQIZ7WF9hlBb2ofDNe2K2dunddFqCOdvLXr7ydRcK51ZwSeHjcjgD1aJkHA'
'9i1zqyboxgd0uAbxVDo6ohnlVqYLtap2tXXcavKm4C9MTpob_rk6FBfEuq4uSsuxFvCER4yG3CYBBa4gZVU", "kid": "devstack_key", "'
'kty": "RSA"}'
),
'JWT_PUBLIC_SIGNING_JWK_SET': (
'{"keys": [{"kid": "devstack_key", "e": "AQAB", "kty": "RSA", "n": "smKFSYowG6nNUAdeqH1jQQnH1PmIHphzBmwJ5vRf1vu'
'48BUI5VcVtUWIPqzRK_LDSlZYh9D0YFL0ZTxIrlb6Tn3Xz7pYvpIAeYuQv3_H5p8tbz7Fb8r63c1828wXPITVTv8f7oxx5W3lFFgpFAyYMmROC'
'4Ee9qG5T38LFe8_oAuFCEntimWxN9F3P-FJQy43TL7wG54WodgiM0EgzkeLr5K6cDnyckWjTuZbWI-4ffcTgTZsL_Kq1owa_J2ngEfxMCObnzG'
'y5ZLcTUomo4rZLjghVpq6KZxfS6I1Vz79ZsMVUWEdXOYePCKKsrQG20ogQEkmTf9FT_SouC6jPcHLXw"}]}'
),
# Generated by `./scripts/generate-jwt-keys.py devstack_key`
'JWT_PRIVATE_SIGNING_JWK': """
{
"d": "B5-oPl1NPbGcVfc9y78lsWF-zCbRELOoHPqFXYul4y2fQeDPhO5LqKrozvLqX8CcibGtIo3mwlby3RvdHHj0flB8zl5iG-U8257e28_DLdINEWiiXgbN4rlRov8Kj9ZBIcBtpUgZGCFrYS9wY5eFeTy-7W2AIfP5eJs1ZMChYULpKPi9jWx99UXFUbcdmbn9Mn6LGIuEVmKL29Z2eg-sF5OUY456WdEIDNQvmvCO5QPOkN1vWEYcC6vPThu3i02QKPVg8sJ9qYHrEZASDp7AwaMJzekb95IGc6H4k_v1JNMSYO2PILbWAjix1LUgWxfJ4kHV1_Wk0cGaEtQdFQopcQ",
"dp": "ikQrGl0fyaHhg7LZD2KHKRd7Qry9BQ7y-xsXgZLpwIVvb_mQdEuq-E1wTb79MYliu710WyKHGkSZuAqPr00K1n_Dn8EtyN0Teq_0NVZUeCJvw3BPvfQg2YHp9p7ZVuOOKNH5zbq9h6bnXY3JuKSoFSNHvBXvezniD6oipEjOyYE",
"dq": "g3UuZo5RpfoAj8CyyAe6C5uDLxVTChKhcRB4MgzR1aoyBvV1OjkKyrwvk67peFuepuCS4VFMH5m5dCP-2yn6tN2CEbYT92VoTIwHtz1KrbL0IMJXKj1_67bYwcpu1I0T-21dKItEyD2tsr_ZOXUCJNzDV9TUVgSnqQ0RrzEXuGE",
"e": "AQAB",
"key_ops": [
"sign"
],
"kid": "devstack_key",
"kty": "RSA",
"n": "ptX-wylRklr_xX5YQpYaVMW8vMx-Y1miaGLZAQxeL_TsqNWn40MMMxT2b2dFBTwOIXwgwnoNvZj3vASMpe2TVNyOZvr52QG1vveOiXeGlB5sIelI_qsWKfJlc9K949FS2tdof9xM3mKQDDVj9Bw3B8a9kr8lHfMV6XKnajxnrnsAEZF8o_-9juh6rJKaJXcnBLDHhqmfNiIxqr9Q37rc7eMI3LspZngoIr1zg_mU4PEzMkjIVnpQbsgV_Y_YiYvG-xUbHVg2KhR7wI12u0bzjfLRJ8CoFfSrl1bHZ8iP0eXbSP2x7fCz1J0HagAqWCSiGCbYf-HmypoxTdUzIgj8EQ",
"p": "vLgzr9t1VIvJ8koHAcSTz150qpEwCUbYjrRvDJhqORCMhqi8QaoCPTVch7dg6L8w6DNwekdTqsHrVpt3erx-GXo16P5H4VkfxlopUNcFR90RLXfI-BZX786Kqnx1qoIIFasM4STTkaOcC-KF9oXDDyjYKMNo7mRN2VYrlRa1HVk",
"q": "4lCMfjBrhKonm4NP7CpMr2udnrxc2iMZqOnDR0ov8333j7gZf5JI7B1V8TH8jU8ansEKbDeAuAezRN8tGrdwPiN_9FOkGGFD_M0bwU3-Z_n8orrlNldGkJob3zRSvDab6U5chPBagzsjNsb5NAnDAU-K25tDdJ1mETGKNcNqZXk",
"qi": "sEaTNgVDqCcYRnKOnA8GGrri665m1fPG2umlv98NKAw3C9xgska3DZi__VFBaSDrz5hJlZgyqZHfeB7yY5fd35yyVkkmHmN5g7fTqBXKso9TBXkvLb1lbpRZmTCgtBezUV_jb99724WkVnePFIYHJHAIVGIStp7kLvqoNVNzNhs"
}
""",
'JWT_PUBLIC_SIGNING_JWK_SET': """
{
"keys": [
{
"e": "AQAB",
"key_ops": [
"verify"
],
"kid": "devstack_key",
"kty": "RSA",
"n": "ptX-wylRklr_xX5YQpYaVMW8vMx-Y1miaGLZAQxeL_TsqNWn40MMMxT2b2dFBTwOIXwgwnoNvZj3vASMpe2TVNyOZvr52QG1vveOiXeGlB5sIelI_qsWKfJlc9K949FS2tdof9xM3mKQDDVj9Bw3B8a9kr8lHfMV6XKnajxnrnsAEZF8o_-9juh6rJKaJXcnBLDHhqmfNiIxqr9Q37rc7eMI3LspZngoIr1zg_mU4PEzMkjIVnpQbsgV_Y_YiYvG-xUbHVg2KhR7wI12u0bzjfLRJ8CoFfSrl1bHZ8iP0eXbSP2x7fCz1J0HagAqWCSiGCbYf-HmypoxTdUzIgj8EQ"
}
]
}
""",
})
add_plugins(__name__, ProjectType.LMS, SettingsType.DEVSTACK)

Expand Down
54 changes: 54 additions & 0 deletions scripts/generate-jwt-keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env python
# Generate public/private JWKs for asymmetric JWTs (RSA 4096).
Comment on lines +1 to +2
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out this is somewhat redundant with the existing generate_jwt_signing_key management command, but there's a bit of a chicken-and-egg problem as that command still needs to be converted over to use PyJWT. That might mean dropping the nice "add to existing key set" feature. In the meantime this PR will just have to serve as reference (and a working source of keys), while I do a key rotation.

#
# To use: Open a virtualenv, run `make requirements`, and then run this script as:
#
# ./scripts/generate-jwt-keys.py some-key-id
#
# The public and private keys will be printed to standard out.

import json
import sys
from Cryptodome.PublicKey import RSA
from jwt.algorithms import get_default_algorithms


args = sys.argv[1:]
if len(args) == 1:
kid = args[0]
else:
print("Call this script with an ID for the new key, e.g. lms-prod-20230403")
exit(1)


private_rsa_key = RSA.generate(2048)
public_rsa_key = private_rsa_key.publickey()

algo = get_default_algorithms()['RS512']

def print_key(k):
pem = k.export_key('PEM').decode()
jwk = json.loads(algo.to_jwk(algo.prepare_key(pem)))
jwk['kid'] = kid
jwk_pretty = json.dumps(jwk, indent=4, sort_keys=True)
print(jwk_pretty)

print("Public key, to add to \"keys\" list of JWT_PUBLIC_SIGNING_JWK_SET:\n")
print_key(public_rsa_key)
print("\n\n")
print("Private key, to encrypt and set as JWT_PRIVATE_SIGNING_JWK:\n")
print_key(private_rsa_key)

# private_jwk_key_dict = json.loads(private_jwk_key_str)
# public_jwk_key_dict = json.loads(public_jwk_key_str)


# ###################################
# # Storing keys in JWK JSON format #
# ###################################
# with open('keys/private_jwk_key.json', 'w') as f:
# json.dump(private_jwk_key_dict, f, indent=4, sort_keys=True)

# with open('keys/public_jwk_key.json', 'w') as f:
# json.dump(public_jwk_key_dict, f, indent=4, sort_keys=True)