Pepperdash.Essentials.Plugins.PasswordManager 1.0.0

Password Manager EPI (c) 2025

License

Provided under MIT license

Overview

This Essentials Plugin Interface (EPI) provides user and password management functionality. Users are stored in a JSON file with the following properties:

• username: The user's unique identifier
• password: The user's password
• access: The user's access level (integer)

The plugin uses a Server/Client architecture to support multiple touch panels accessing the same user database simultaneously.

Architecture

Server/Client Model

The plugin consists of two device types:

• Password Manager Server (passwordManagerServer): Central device that manages user data and file persistence. Only one server is needed per system.
• Password Manager Client (passwordManagerClient): Bridge-enabled device for each touch panel. Multiple clients can connect to one server.

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│   Touch Panel 1 │     │   Touch Panel 2 │     │   Touch Panel 3 │
│   (EISC Bridge) │     │   (EISC Bridge) │     │   (EISC Bridge) │
└────────┬────────┘     └────────┬────────┘     └────────┬────────┘
         │                       │                       │
         ▼                       ▼                       ▼
┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│  pwClient-tp1   │     │  pwClient-tp2   │     │  pwClient-tp3   │
│    (Client)     │     │    (Client)     │     │    (Client)     │
└────────┬────────┘     └────────┬────────┘     └────────┬────────┘
         │                       │                       │
         └───────────────────────┼───────────────────────┘
                                 │
                                 ▼
                    ┌────────────────────────┐
                    │      pwServer          │
                    │      (Server)          │
                    │                        │
                    │  ┌──────────────────┐  │
                    │  │  users.json      │  │
                    │  └──────────────────┘  │
                    └────────────────────────┘

Features

• Server/Client architecture for multi-panel support
• Store user credentials in JSON file with automatic persistence
• Create and delete users via bridge joins
• Validate user credentials (login)
• Input feedback signals (UsernameInputFb, PasswordInputFb, AccessInputFb)
• Unmask password signal - hold digital join high to reveal password
• Clear inputs on login - automatically clear input fields after successful login
• Navigate through user list with next/previous selection
• Update user passwords and access levels
• Masked password display option for security
• Console commands for administration
• Default users seeding on first run

Dependencies

The Essentials libraries are required (v2.12.1+). They are referenced via NuGet.

Configuration

Server Configuration

{
    "key": "pwServer",
    "uid": 10,
    "name": "Password Manager Server",
    "type": "passwordManagerServer",
    "group": "plugin",
    "properties": {
        "filePath": "PasswordManager/users.json",
        "saveDelayMs": 1000,
        "defaultUsers": [
            {
                "username": "admin",
                "password": "admin123",
                "access": 3
            },
            {
                "username": "tech",
                "password": "tech123",
                "access": 2
            },
            {
                "username": "user",
                "password": "user123",
                "access": 1
            }
        ]
    }
}

Client Configuration

{
    "key": "pwClient-tp1",
    "uid": 11,
    "name": "Password Manager Client TP1",
    "type": "passwordManagerClient",
    "group": "plugin",
    "properties": {
        "serverKey": "pwServer",
        "maskPasswords": true,
        "clearInputsOnLogin": true
    }
}

Bridge Configuration

{
    "key": "passwordManagerBridge",
    "uid": 20,
    "name": "Password Manager Bridge",
    "group": "api",
    "type": "eiscApiAdvanced",
    "properties": {
        "control": {
            "tcpSshProperties": {
                "address": "127.0.0.2",
                "port": 0
            },
            "ipid": "B1",
            "method": "ipidTcp"
        },
        "devices": [
            {
                "deviceKey": "pwClient-tp1",
                "joinStart": 1
            }
        ]
    }
}

Server Configuration Properties

Client Configuration Properties

Bridge Join Map (Client)

Join numbers are organized into logical groups with room for expansion:

Digital Joins - Feedbacks (1-7)

Digital Joins - Actions (11-20)

Digital Joins - Navigation (25-27)

Digital Joins - User List (31-80)

Analog Joins (1-5)

Serial Joins - Device/Status (1-6)

Serial Joins - Inputs (7-9)

Serial Joins - List/Edit (11-15)

Serial Joins - User List (31-50)

UI Workflow Example

Manage Users List

1. Display users using UserListItemFb[1-20] (S31-50)
2. Show/hide list items using UserListVisibleFb[1-20] (D61-80)
3. When user taps a list item, pulse corresponding UserListSelect[n] (D31-50)
4. Navigate to edit page

Add User

1. User enters username via UsernameInput (S7)
2. User enters password via PasswordInput (S8)
3. Monitor SaveEnabledFb (D6) to enable/disable Save button
4. On Save press, pulse CreateUser (D14)
5. Check CreateUserSuccessFb (D3) and StatusMessageFb (S2) for result

Edit User

1. Pulse LoadSelectedUserToInputs (D19) to populate input fields
2. EditingUsernameFb (S12) shows original username
3. User modifies UsernameInput and/or PasswordInput
4. Monitor HasChangesFb (D7) to detect unsaved changes
5. Monitor SaveEnabledFb (D6) to enable/disable Save button
6. On Save press, pulse UpdateSelectedUser (D20)
7. Check UpdateUserSuccessFb (D5) for result

Delete User

1. From edit page, pulse DeleteSelectedUser (D16)
2. Check DeleteUserSuccessFb (D4) for result

Password Visibility Toggle

• Hold UnmaskPasswordInput (D12) high to show actual password in PasswordInputFb
• Release to show masked password

Console Commands

Server Console Command

The server registers a console command pwmgr-{key} with the following subcommands:

pwmgr-pwServer list                              - List all users
pwmgr-pwServer add [username] [password] [access] - Add a new user
pwmgr-pwServer del [username]                    - Delete a user
pwmgr-pwServer val [username] [password]         - Validate credentials

Legacy Single-Device Mode

The original single-device mode (passwordManager type) is still available for backward compatibility:

{
    "key": "passwordManager-1",
    "type": "passwordManager",
    "properties": {
        "filePath": "PasswordManager/users.json",
        "maskPasswords": true,
        "saveDelayMs": 1000,
        "defaultUsers": [...]
    }
}

User File Format

The users are stored in a JSON file with the following format:

[
    {
        "username": "admin",
        "password": "admin123",
        "access": 3
    },
    {
        "username": "tech",
        "password": "tech123",
        "access": 2
    }
]

Access Levels

Access levels are integers that can be used to define different permission tiers. Suggested values:

Build Instructions

NuGet Package

A NuGet package is automatically generated when the plugin is built. The package properties are defined in the .csproj file.