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.

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

Encrypt tutors.json course file #689

Open
edeleastar opened this issue Jan 29, 2024 · 1 comment
Open

Encrypt tutors.json course file #689

edeleastar opened this issue Jan 29, 2024 · 1 comment

Comments

@edeleastar
Copy link
Contributor

When tutors reader launches, it will use the url to read the json control file for the course:

This is currently sent in plain text. Propose a mechanism to encrypt (and perhaps compress) this content.

The generator project will also have to be changed:

Specifically this component:

@lgriffin
Copy link
Contributor

I have opened a PR for this as this is a multi stage implementation. The first is to agree on a common approach for encryption and compression. The PR put forward is one approach where we create a CLI to enable users to encrypt / compress using our tool that way we can control the formatting e.g. some of the tools are really sensitive to encoding and content types. The approach put forward is using simple text based keys but the design is extensible enough to plug in public/private key or any other approach. That might be overkill but the option is there.

Once the PR is merged, we can use the functions within it to simply plug into the course.ts. The proposed structure of the encrypted (and / or compressed) JSON file is to have two elements that can quickly show us if the course is either encrypted or compressed and take appropriate action. This was more for my local testing but I left it in the PR as it might simplify the course.ts logic. A simple refactor may be necessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants