Use protobuf to parse the nsjail config and remove redundancies #88
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include a helper shell script for compilation.
The Python script uses the same underlying code Falcon uses to invoke nsjail. It allows for the omission of redundant shell code that set up cgroups and nsjail args. This is also a step towards removing dependence on shell scripts and thus resolving #73.
MarkKoz
added
type: feature
jb3
approved these changes
Feb 2, 2021
I plan to replace the script with on written in Python when I do #73. I'll document things better at that point.
Good point. I should document the config format, which is really just linking to the nsjail readme and maybe the protobuf file. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #74
Protobuf is used to parse the config because it's the proper way to do it and it's less maintenance than a custom parser. A Python module is generated from the
protoctool. There's a simple shell script that gets theconfig.protofrom NsJail's GitHub and invokesprotoc. The Python module only needs to be re-generated when NsJail is updated.I realise more shell scripts go against #73, but I plan to address that issue in a separate PR. It'll also address the NsJail version currently being hard-coded in separate places (the Python script and the Dockerfile).
I managed to remove one shell script anyway since it was practically necessary to reduce redundancy. It required using the code in snekbox to invoke NsJail. This has the benefit of all the code that parses the config and sets up cgroups. I could have imported it from the shell script, but I didn't want to write Python code in-line in the
.profilescript.I'll also write unit tests later, since there may be more refactoring down the road. It's not worth it right now if it's just gonna have to get changed again.