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

module writing documentation? #133

Open
eylles opened this issue Sep 1, 2021 · 1 comment
Open

module writing documentation? #133

eylles opened this issue Sep 1, 2021 · 1 comment

Comments

@eylles
Copy link

eylles commented Sep 1, 2021

perhaps a stupid question but is there documentation on writing modules for xsecurelock?
i'm writing a screensaver module and i had to look at the script for the mpv module + snippets from the one of the issues to figure it out, next i'm planning to take a jab at writing an authentication module and honestly i'm not versed enough in c to really use the default auth module as a starting point, so i wonder is there a documentation on what the auth module needs to do, window properties it needs to set, does it need to call the pam helper or it only reading text from the keyboard and outputting out to stdout is enough? i'm a bit a miss on this one.

@divVerent
Copy link
Contributor

divVerent commented Sep 1, 2021

This is explained here:

https://github.com/google/xsecurelock#writing-your-own-module-2

Documentation for auth modules is there too - you can go via having the authproto module talk to PAM (recommended, and necessary on FreeBSD) or you can create your own authentication.

Window properties are up to you, but the parent window ID is passed by environment variable.

In that parent ID, you're allowed to either draw or create subwindows, but not to change properties.

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