Remoto - VFS
|
The VFS_passwd authenticator uses a passwd file to store username, hashed password, uidnumber, a real name, and group membership. More...
#include <VFS_passwd.h>
Public Member Functions | |
Q_INVOKABLE | VFS_passwd (QString file) |
virtual | ~VFS_passwd () |
virtual QString | reportDetails () |
Additional details for a generated report. More... | |
![]() | |
VFS_auth () | |
virtual | ~VFS_auth () |
virtual VFS_node * | find (VFS_request *r) |
Find a node using a VFS_request. More... | |
virtual bool | isContainer () |
A VFS_auth node cannot contain children. More... | |
![]() | |
Q_INVOKABLE | VFS_node () |
The VFS_node constructor will add its instance to the VFS_node::__allNodes global node registry, observing thread safety rules. More... | |
virtual | ~VFS_node () |
VFS_node destructor. More... | |
virtual VFS_node * | append (QString name, VFS_node *node, bool containerCheck=true, QString user="server") |
Append a VFS_node as a child of this node. More... | |
QString | className () |
Return the class name of a node. More... | |
virtual VFS_request * | createRequest (VFS_request::requestType type, QString path, QString user="unknown", QJsonDocument data=QJsonDocument(), QJsonObject metadata=QJsonObject(), bool dontDelete=false) |
Create a new VFS_request with this object as _origin. More... | |
VFS_node * | find (QString path) |
Find a node by string path. More... | |
VFS_node * | findChildWithName (QString name) |
Check if a child with a given name exists. More... | |
virtual VFS_node * | mount () |
Mount this node. More... | |
QString | uniqueChildName (QString name) |
Generate a unique child name. More... | |
virtual VFS_node * | unmount () |
Unmount this node. More... | |
virtual bool | validChildName (QString name) |
Check if a node name is valid. More... | |
Protected Member Functions | |
virtual void | ls (VFS_request *r) |
List the users available for this auth method. More... | |
virtual void | read (VFS_request *r) |
Perform an authentication request by read()ing from this node. More... | |
![]() | |
virtual QByteArray | icon () |
Return the users icon from VFS_icons. More... | |
![]() | |
virtual void | aclDefaults (VFS_request *r) |
Return default values and features associated wth this node. More... | |
void | addACLDefault (QJsonObject &acl, bool value, QString description="") |
Add a default value to the acl object. More... | |
void | addACLFeature (QJsonObject &acl, QString feature, bool value, QString description="") |
Add a feature to the acl object. More... | |
void | addACLFeatureGroup (QJsonObject &acl, QString feature, QString group, bool value) |
Add a feature group to the acl object. More... | |
void | addACLFeatureUser (QJsonObject &acl, QString feature, QString user, bool value) |
Add a feature user to the acl object. More... | |
void | addACLGroup (QJsonObject &acl, QString group, bool value) |
Add a group to the acl object. More... | |
void | addACLUser (QJsonObject &acl, QString user, bool value) |
Add a user to the acl object. More... | |
virtual void | issueRequest (VFS_node *target, VFS_request *t) |
Issue a VFS_request to its target. More... | |
virtual void | issueRequest (VFS_request *t) |
A convenience function. More... | |
virtual void | issueResponse (VFS_request *t) |
Once a request has been completed, issue a response. More... | |
virtual void | metadata (VFS_request *r) |
Fetch the metadata of this node. More... | |
virtual void | releaseLock (VFS_request *r) |
Release a lock on this node. More... | |
virtual void | report (VFS_request *r) |
Report debugging information about the current state of this node. More... | |
virtual void | requestLock (VFS_request *r) |
Request a lock on this node. More... | |
virtual void | rm (VFS_request *r) |
Remove a child entry from a node, or the node itself. More... | |
virtual void | submit (VFS_request *r) |
Submit a diff to a node. More... | |
virtual void | subscribe (VFS_request *r) |
Add an entry to this node's _subscription list. More... | |
virtual void | unsubscribe (VFS_request *r) |
Remove an entry from this node's _subscription list. More... | |
virtual void | unsubscribePath (QString path) |
Unsubscribe all references to a subpath. More... | |
virtual void | write (VFS_request *r) |
Write data to this node. More... | |
Private Attributes | |
QString | _passwordFile |
The filesystem path to the passwd file. More... | |
Additional Inherited Members | |
![]() | |
virtual void | executeRequest (VFS_request *t) |
Execute a VFS_request. More... | |
![]() | |
virtual void | applyDiff (VFS_request *r) |
Apply a diff received via subscription. More... | |
virtual void | executeRequest (VFS_request *t) |
Based on the VFS_request::requestType, execute the function associated with an operation. More... | |
void | notifySubscribers (VFS_node *origin, VFS_request *t) |
Propagate a diff to subscribers. More... | |
virtual void | receiveResponse (VFS_request *t) |
Once a VFS_request has been completed, a response will be issued back to its _origin. More... | |
void | remove (bool andDelete) |
Remove a child node. More... | |
virtual void | remove (VFS_node *node=nullptr, QString *name=nullptr, QString user="server") |
Remove a child node from this node. More... | |
virtual void | subtreeRequest (VFS_request *t) |
find() the target of a VFS_request, and execute the request More... | |
virtual void | unsubscribeAll (VFS_node *n) |
Remove all references to a subscriber from this node. More... | |
![]() | |
void | diff (VFS_node *origin, VFS_request *t) |
Emit a diff, which will trigger notifySubscribers() for a mounted node. More... | |
void | finished (bool andDelete=false) |
Emitted if a thread fails to create its node, or a node is rm()'d, or any other reason a node has completed its lifecycle. It is deleted if andDelete==true . More... | |
void | mounted () |
Emitted when a node is mount()ed. More... | |
void | unmounted (VFS_node *self) |
Emitted when a node is unmount()ed. More... | |
![]() | |
static bool | __isNode (VFS_node *) |
Check to see if a node is in the global registry. More... | |
static QString | code (QString nodename, QString libname, QString &error) |
Fetch code or any other resource from a node. More... | |
![]() | |
VFS_children | _children |
This node's children. More... | |
QMutex | _lock |
A recursive mutex that is local to this node. More... | |
VFS_subscriptionType | _subscribers |
This node's subscribers. These subscribers will receive diff notifications. More... | |
The VFS_passwd authenticator uses a passwd file to store username, hashed password, uidnumber, a real name, and group membership.
The format of the passwd file is:
username1 password1hash uidnumber "Real Name" group1,group2 username2 password2hash uidnumber "Real Name 2" group2,group3,group4
Each line is separated by a newline and contains usernames who will be authenticated using a password.
Passwords are stored using an MD5 hash converted to a hexidecimal value. The password hash field is required.
If the uidnumber is not present or does not parse as an integer, it will default to 0.
The real name field should be surrounded by quotes and is optional. If the real name is missing the username will be used.
The group field is a comma separated list and is optional. If missing, the user will not belong to any groups.
Spaces should only appear between fields or within quotes for the real name.
Definition at line 6 of file VFS_passwd.h.
|
explicit |
passwdFile | Path to the passwd file |
Auth requests will use the hashed password values stored in the passwd file to determine authentication.
Definition at line 37 of file VFS_passwd.cpp.
|
virtual |
Definition at line 43 of file VFS_passwd.cpp.
|
protectedvirtual |
List the users available for this auth method.
r | The VFS_request object |
Reimplemented from VFS_node.
Definition at line 119 of file VFS_passwd.cpp.
|
protectedvirtual |
Perform an authentication request by read()ing from this node.
r | The VFS_request object |
When a user requests authentication against this node, the passwd file is opened and each line is sequentially read and tested against provided credentials.
Credentials must be supplied in the VFS_request::_data object:
d["username"] = "username"; d["password"] = "password";
The password value is hashed and compared to the lines in the passwd file. If no matching lines are found, r->_success = false
will be set.
Reimplemented from VFS_node.
Definition at line 63 of file VFS_passwd.cpp.
|
virtual |
Additional details for a generated report.
This is useful in subclasses for providing class-specific information of any kind. For instance, VFS_cron::reportDetails() will list all active events.
Reimplemented from VFS_node.
Definition at line 183 of file VFS_passwd.cpp.
|
private |
The filesystem path to the passwd file.
Definition at line 21 of file VFS_passwd.h.