OpenSCADAWiki: Doc/API/part10 ...

10. Ïîäñèñòåìà "Áåçîïàñíîñòü" (TSeñurity)

Ïîäñèñòåìà áåçîïàñíîñòè ïðåäñòàâëåíà îáúåêòîì êîòîðûé ñîäåðæèò îáúåêòû ãðóïï TGroup è ïîëüçîâàòåëåé TUser.

Îáúåêò ïîëüçîâàòåëÿ TUser ñîäåðæèò ïîëüçîâàòåëüñêóþ èíôîðìàöèþ è âûïîëíÿåò ïðîâåðêó àóòåíòè÷íîñòè ïîëüçîâàòåëÿ â ñîîòâåòñòâèè ñ óêàçàííûì ïàðîëåì.

Îáúåêò ïîëüçîâàòåëÿ TGroup ñîäåðæèò èíôîðìàöèþ î ãðóïïå ïîëüçîâàòåëåé è âûïîëíÿåò ïðîâåðêó íà ïðèíàäëåæíîñòü ïîëüçîâàòåëÿ ê ãðóïïå.

10.1. Îáúåêò ïîäñèñòåìû "Áåçîïàñíîñòü" (TSeñurity)

Ïóáëè÷íûå äàííûå:

• static const string pHashMagic; — Ñòðîêà-óêàçàòåëü (ïðåôèêñ) ïàðîëÿ â õåøå.

Ïóáëè÷íûå ìåòîäû:

• bool access( const string &user, char mode, int owner, int group, int access ); — Ïðîâåðêà äîñòóïà äëÿ ïîëüçîâàòåëÿ user ñ ïðàâàìè mode ê ðåñóðñó ñ âëàäåëüöåì owner è ãðóïïîé access.
• void usrList( vector<string> &list ); — Ñïèñîê ïîëüçîâàòåëåé list.
• void usrGrpList( const string &name, vector<string> &list ); — Ñïèñîê ãðóïï ïîëüçîâàòåëåé list, â êîòîðûå ïîëüçîâàòåëü name âêëþ÷¸í.
• bool usrPresent( const string &name ); — Ïðîâåðêà íà íàëè÷èå óêàçàííîãî ïîëüçîâàòåëÿ name.
• int usrAdd( const string &name, const string &db = "*.*" ); — Äîáàâëåíèå ïîëüçîâàòåëÿ name ñ õðàíåíèåì â ÁÄ db.
• void usrDel( const string &name, bool complete = false ); — Óäàëåíèå ïîëüçîâàòåëÿ name ñ âîçìîæíîñòüþ ïîëíîãî óäàëåíèÿ complete.
• AutoHD<TUser> usrAt( const string &name ); — Ïîäêëþ÷åíèå ê ïîëüçîâàòåëþ name.
• void grpList( vector<string> &list ); — Ñïèñîê ãðóïï ïîëüçîâàòåëåé list.
• bool grpPresent( const string &name ); — Ïðîâåðêà íà íàëè÷èå óêàçàííîé ãðóïïû ïîëüçîâàòåëåé name.
• int grpAdd( const string &name, const string &db = "*.*" ); — Äîáàâëåíèå ãðóïïû ïîëüçîâàòåëåé name ñ õðàíåíèåì â ÁÄ db.
• void grpDel( const string &name, bool complete = false ); — Óäàëåíèå ãðóïïû ïîëüçîâàòåëåé name ñ âîçìîæíîñòüþ ïîëíîãî óäàëåíèÿ complete.
• AutoHD<TGroup> grpAt( const string &name ); — Ïîäêëþ÷åíèå ê ãðóïïå ïîëüçîâàòåëåé name.

10.2. Îáúåêò ïîëüçîâàòåëÿ (TUser)

Ïóáëè÷íûå ìåòîäû:

• TUser( const string &name, const string &db, TElem *el ); — Èíèöèàëèçèðóþùèé êîíñòðóêòîð.
• string name( ); — Èìÿ ïîëüçîâàòåëÿ.
• string descr( ); — Îïèñàíèå ïîëüçîâàòåëÿ.
• string longDescr( ); — Äëèííîå îïèñàíèå ïîëüçîâàòåëÿ.
• string picture( ); — Èçîáðàæåíèå ïîëüçîâàòåëÿ.
• string lang( ); — ßçûê ïîëüçîâàòåëÿ, òîëüêî â ðåæèìå äèíàìè÷åñêîé òðàíñëÿöèè òåêñòîâûõ ïåðåìåííûõ.
• bool sysItem( ); — Ïðèçíàê ñèñòåìíîãî ïîëüçîâàòåëÿ.
• bool auth( const string &pass, string *hash = NULL ); — Ïðîâåðêà àóòåíòè÷íîñòè ïîëüçîâàòåëÿ ïî ïàðîëþ pass. Õåø ïàðîëÿ, åñëè ïîääåðæèâàåòñÿ, ïîìåùàåòñÿ â hash.
• string DB( ); — Àäðåñ ÁÄ ïîëüçîâàòåëÿ.
• string tbl( ); — Àäðåñ òàáëèöû ÁÄ ïîëüçîâàòåëÿ.
• string fullDB( ); — Ïîëíîå èìÿ òàáëèöû ÁÄ ïîëüçîâàòåëÿ.
• void setDescr( const string &vl ); — Óñòàíîâêà îïèñàíèÿ ïîëüçîâàòåëÿ â vl.
• void setLongDescr( const string &vl ); — Óñòàíîâêà äëèííîãî îïèñàíèÿ ïîëüçîâàòåëÿ â vl.
• void setPicture( const string &pct ); — Óñòàíîâêà èçîáðàæåíèÿ ïîëüçîâàòåëÿ â pct.
• void setLang( const string &vl ); — Óñòàíîâêà ÿçûêà ïîëüçîâàòåëÿ â vl.
• void setPass( const string &pass ); — Óñòàíîâêà ïàðîëÿ ïîëüçîâàòåëÿ â pass.
• void setSysItem( bool vl ); — Óñòàíîâêà ïðèçíàêà ñèñòåìíîãî ïîëüçîâàòåëÿ â vl.
• void setDB( const string &vl ); — Óñòàíîâêà àäðåñà ÁÄ ïîëüçîâàòåëÿ.
• TSeñurity &owner( ); — Ïîäñèñòåìà "Áåçîïàñíîñòü" - âëàäåëåö ïîëüçîâàòåëÿ.

10.3. Îáúåêò ãðóïïû ïîëüçîâàòåëåé (TGroup)

Ïóáëè÷íûå ìåòîäû:

• TGroup( const string &name, const string &db, TElem *el ); — Èíèöèàëèçèðóþùèé êîíñòðóêòîð.
• string name( ); — Èìÿ ãðóïïû ïîëüçîâàòåëåé.
• string descr( ); — Îïèñàíèå ãðóïïû ïîëüçîâàòåëåé.
• string longDescr( ); — Äëèííîå îïèñàíèå ãðóïïû ïîëüçîâàòåëåé.
• bool sysItem( ); — Ïðèçíàê ñèñòåìíîé ãðóïïû ïîëüçîâàòåëåé.
• string DB( ); — Àäðåñ ÁÄ ãðóïïû ïîëüçîâàòåëåé.
• string tbl( ); — Àäðåñ òàáëèöû ÁÄ ãðóïïû ïîëüçîâàòåëåé.
• string fullDB( ); — Ïîëíîå èìÿ òàáëèöû ÁÄ ãðóïïû ïîëüçîâàòåëåé.
• void setDescr( const string &vl ); — Óñòàíîâêà îïèñàíèÿ ãðóïïû ïîëüçîâàòåëåé â vl.
• void setLongDescr( const string &vl ); — Óñòàíîâêà äëèííîãî îïèñàíèÿ ãðóïïû ïîëüçîâàòåëåé â vl.
• void setSysItem( bool vl ); — Óñòàíîâêà ïðèçíàêà ñèñòåìíîé ãðóïïû ïîëüçîâàòåëåé â vl.
• void setDB( const string &vl ); — Óñòàíîâêà àäðåñà ÁÄ ãðóïïû ïîëüçîâàòåëåé.
• bool user( const string &name ); — Ïðîâåðêà íà ïðèíàäëåæíîñòü ïîëüçîâàòåëÿ ê ãðóïïå name.
• void userAdd( const string &name ); — Äîáàâëåíèå ïîëüçîâàòåëÿ name â ãðóïïó.
• void userDel( const string &name ); — Óäàëåíèå ïîëüçîâàòåëÿ name èç ãðóïïû.
• TSeñurity &owner( ); — Ïîäñèñòåìà "Áåçîïàñíîñòü" - âëàäåëåö ãðóïïû ïîëüçîâàòåëåé.