You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Kevin F 9f44a9cffd Added xdotool modifier key support and refactored server documents 6 days ago
.vscode + Finished authentication 5 months ago
security Split the client and server into different Go packages and binaries to make it easier to do cross platform builds and to be more unixy 1 week ago
server Added xdotool modifier key support and refactored server documents 6 days ago
tools Added IME and stdin tools 2 weeks ago
util added utility to remove fenced code blocks from final html docs since srcweave is a pain in that regard 5 months ago
.gitattributes added gitattributes with linguist ignores 5 months ago
.gitignore + Started ThreatModel.md 1 month ago
Building.md Add building.md 1 month ago
Client.md Started implementing modifier keys 1 week ago
Dependencies.md + Started ThreatModel.md 1 month ago
EnvironmentVariables.md Added xdotool modifier key support and refactored server documents 6 days ago
LICENSE.md Add license and move websocket to Streaming file 1 month ago
Makefile Added xdotool modifier key support and refactored server documents 6 days ago
ReadMe.md Started implementing modifier keys 1 week ago
ThreatModel.md Started client 1 month ago

ReadMe.md

GoSmartKeyboard

Copyright 2022 Kevin Froman Licensed under GPLv3

Work in progress

Introduction

GoSmartKeyboard is a daemon that allows you to have a more powerful keyboarding experience. It is meant to be used with a secondary device, such as an Android phone or a raspberry pi.

This is done with a simple websocket server meant to accept a single connection, authenticate it, and stream UTF16 characters and send them as key strokes into the window manager. With a simple daemon like this we can enhance keyboarding with inteligent features.

The goal of this particular daemon is not to perfectly emulate a HID, so it may trip up on Windows UAC or game anticheat systems.

A client is included that simply connects and authenticates. It is meant to be used with unix philosophy modules, for example a password manager wrapper. A UI could then wrap the client and said modules.

See Building.md for instructions on how to build this literate project.

Why a smart keyboard?

Keyboards have been an essential element of computing since the beginning, however they have not evolved much. Everything has a smart variant, so why not keyboards?

A smart keyboard could, for example, be used for the following:

  • Typical macros
  • Buffer typed text before sending it to the client, preventing invalid commands or input. (This would also save some CPU on low power machines, this is how many early teletype systems worked)
  • Clever CLI tricks, think vim or cowsay on your keyboard!
  • Isolated password manager
  • One Time Passwords
  • Virtual keyboard switch or communicating with multiple daemons at once
  • Easily attach to VMs
  • Text storage, such as configuration or SSH pubkeys
  • On-the-fly spell checking or translation
  • On-the-fly encryption (ex: PGP sign every message you type), isolated from the perhaps untrusted computer
  • Easy layout configuration
  • Delay keystrokes by a few dozen or so milliseconds to reduce key stroke timing biometrics

Some points about the design of this project:

  • Written in go with the literate tool srcweave, so this markdown book is actually the source code
  • The project is test-driven
  • KISS principle above All
  • Small and light core
  • Advanced features provided via plugins
  • Well defined threat model

Entrypoint

Right out of the gate, we make sure a token is provisioned. In the future we will use the system keyring.

Then we can start the web server and listen for websocket connections.


--- entrypoint

    func main(){
        
        tokenBase64, _ := auth.ProvisionToken()
        if len(tokenBase64) > 0 {
            fmt.Println("This is your authentication token, it will only be shown once: " + tokenBase64)        
        }


        server.StartServer()
    }

---


--- /server/main.go
    package main

    import(
        "fmt"
        "keyboard.voidnet.tech/server"
        "keyboard.voidnet.tech/auth"
    )


    @{entrypoint}

---



--- set network bind globals

    var string unixSocketPath
    var bool unixSocketPathExists
    var string tcpBindAddress
    var bool tcpBindAddressExists
    var string tcpBindPort
    var bool tcpBindPortExists

---