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

[Discussion&Suggestion]: Quiche and BoringTun #25

Open
radiumatic opened this issue Oct 15, 2024 · 4 comments
Open

[Discussion&Suggestion]: Quiche and BoringTun #25

radiumatic opened this issue Oct 15, 2024 · 4 comments

Comments

@radiumatic
Copy link

From a very basic glance at quinn's repo, I think the only advantage over Quiche is pluggable cryptography, but I'm not sure. Just wanted to say that you might want to take a look, as it's potentiality better maintained and supported than quinn. (?)

If you ever want to support Wireguard, BoringTun might be useful. (In addition to the protocol itself, maybe attempting to tunnel Wireguard over insecure configurations, and dropping it if the server doesn't respond?)

P.S: Can you please use an automatic docs generator for the config and implement detailed errors for the parser? I'm trying to config something and it just fails with YAML: data did not match any variant of untagged enum Config.

@cfal
Copy link
Owner

cfal commented Oct 16, 2024

boringtun would be interesting to get working. i'm not aware of an easy way to auto generate docs, feel free to contribute a PR or discuss here if you have an idea. perhaps an LLM can do the heavy lifting.

@radiumatic
Copy link
Author

i'm not aware of an easy way to auto generate docs, feel free to contribute a PR or discuss here if you have an idea. perhaps an LLM can do the heavy lifting.

Maybe defining config options as structs and adding metadata as comments then parsing it with a script can work.
It works for the likes of OpenAPI and Sphinx, so I can't see why wouldn't it work for this purpose.

Since the config options are the heavy part of the work, the rest can be done with a LLM or done by hand.

@cfal
Copy link
Owner

cfal commented Dec 11, 2024

here's some generated docs, still needs a bit of work: https://github.com/cfal/shoes/blob/master/CONFIG.md

@radiumatic
Copy link
Author

Thanks.

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

No branches or pull requests

2 participants