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

UX: plugin interface documentation #58

Closed
smlx opened this issue Mar 21, 2022 · 1 comment
Closed

UX: plugin interface documentation #58

smlx opened this issue Mar 21, 2022 · 1 comment

Comments

@smlx
Copy link

smlx commented Mar 21, 2022

What were you trying to do

I'm interested in writing an age plugin along similar lines to age-plugin-yubikey.

What happened

I searched but couldn't find any documentation on the plugin interface exposed by rage (and age at some point I guess).

It is possible to read the code and play around with age-plugin-yubikey to figure out how to implement an equivalent interface, but I wondered: is there any documentation on the plugin executable interface? For example: which commands or flags are required? which are optional? what are their arguments? what do they return? etc.

Does any documentation along those lines exist?

@str4d
Copy link
Owner

str4d commented May 1, 2022

Yes! I'd been developing the age plugin spec in a HackMD, but it has now been moved to here: C2SP/C2SP#5 (and once that is merged, https://c2sp.org/age-plugin).

I also implemented the age-plugin Rust crate (which this plugin uses), which handles all the IPC logic, so all you need to implement is the plugin logic.

@str4d str4d closed this as completed May 1, 2022
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