CmpUserMgr Library Documentation ¶ Company System Title CmpUserMgr Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library provides access to the user management. The user management in the runtime system is based on ACL (Access Control Lists). Here we have Users and UserGroups and access rights on objects. Every object in the runtime system, that must be protected with access rights, is registered dynamically during startup of the runtime by the corresponding component under the appropriate folder. The objects in the runtime system are organized as a tree with 2 root nodes: - Runtime system object : "Device" |----- "PlcLogic" |----------- "Application" |----- "Logger" |----- "Settings" |----- "UserManagement" - File system objects : "/" |----- "Temp" |----------- "Test.txt" On every object there are assigned all user groups. And for every user group you can specify the appropriate access rights. There are 5 different access rights that can be specified at every group for each object: - USERDB_RIGHT_NONE: Access denied - USERDB_RIGHT_VIEW: Only view rights on the object. Object cannot be modified in any case! - USERDB_RIGHT_MODIFY: Object can be viewed and modified - USERDB_RIGHT_EXECUTE: Object can be executed - USERDB_RIGHT_ADD_REMOVE: It is allowed to add and remove objects or sub objects - USERDB_RIGHT_ALL: All rights allowed on the object Not every access right is retrieved by an object. Which access rights are used are specified by each object and are masked in the user rights editor in the programming system! Indices and tables ¶ 1 Based on CmpUserMgr.library, last modified 20.04.2021, 15:58:15. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:58:15.
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpUserMgr Implementation ¶ Library Identification ¶ Placeholder: CmpUserMgr Implementation Default Resolution: CmpUserMgr Implementation, * (System) Namespace: CmpUserMgr_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr Implementation CmpUserMgr Interfaces ¶ Library Identification ¶ Name: CmpUserMgr Interfaces Version: newest Company: System Namespace: CmpUserMgr_Interfaces Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr Interfaces, * (System)
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:58:15 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpUserMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpUserMgr.clean.json version version 2.0.0.0 ProjectInformation IsContainerLibrary bool True IsEndUserLibrary False Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:58:15 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpUserMgr Title CmpUserMgr Version version 3.5.17.0
CmpUserMgr Interfaces Library Documentation ¶ Company System Title CmpUserMgr Interfaces Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library contains the constants used by the CmpUserMgr component. Contents: ¶ CmpUserMgr GlobalConstants Structs Types Indices and tables ¶ 1 Based on CmpUserMgr_Itfs.library, last modified 02.03.2023, 11:03:11. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:03:13.
CmpUserMgr ¶ GlobalConstants Constants (GVL) EventIDs (GVL) Properties (GVL) Structs UserMgrCredentials (Struct) UserMgrCredentials_Password (Struct) UserMgrCredentials_Store (Union) Types EVTPARAM_CmpUserMgrDatabaseChanged (Struct) UserMgrCacheValue (Struct) UserMgrCredentials_Type (Enum) UserMgrTypeClass (Enum) UserMgrValue (Union)
GlobalConstants ¶ Constants (GVL) EventIDs (GVL) Properties (GVL)
Constants (GVL) ¶ User rights Defined rights that can fully control the access to an object InOut: Scope Name Type Initial Comment Constant USERMGR_RIGHT_NONE DWORD 0 Access denied USERMGR_RIGHT_VIEW DWORD 1 Only view rights on the object. Object cannot be modified in any case! USERMGR_RIGHT_MODIFY DWORD 2 Object can be viewed and modified USERMGR_RIGHT_EXECUTE DWORD 4 Object can be executed USERMGR_RIGHT_ADD_REMOVE DWORD 8 It is allowed to add and remove objects or sub objects USERMGR_RIGHT_OEM DWORD 16#FF000000 The upper 8 bits of the access rights are reserved for OEM specific access rights USERMGR_RIGHT_ALL DWORD 16#FFFFFFFF All rights allowed on the object
EventIDs (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Constant CMPID_CmpUserMgr DWORD 16#61 EVTPARAMID_CmpUserMgrDatabaseChanged WORD 16#1 EVTVERSION_CmpUserMgrDatabaseChanged WORD 16#1 EVT_UserMgrDatabaseChanged DWORD (SHL(UINT_TO_DWORD(EVTCLASS_INFO), 16) OR 16#1)
Properties (GVL) ¶ Properties Properties for a user. Use as bit-mask. InOut: Scope Name Type Initial Constant USERMGR_USER_PROP_PASSWORD_EXPIRED DWORD 16#1000 USERMGR_USER_PROP_ALLOW_CHANGE_PASSWORD DWORD 16#2000 USERMGR_USER_PROP_DEFAULT DWORD (USERMGR_USER_PROP_ALLOW_CHANGE_PASSWORD + USERMGR_USER_PROP_PASSWORD_EXPIRED)
Structs ¶ UserMgrCredentials (Struct) UserMgrCredentials_Password (Struct) UserMgrCredentials_Store (Union)
