Swift-Keylogger

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #android #docker #nodejs #awesome #cli #pytorch #security #mcp #ios #openai

Swift-Keylogger

(★ 1,160)

Keylogger for mac written in Swift using HID

File Explorer

Download Latest Version (.zip)

- - CallBackFunctions.swift
  - Keylogger.swift
  - main.swift
- - project.pbxproj
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# macOS Swift-Keylogger

[![Backers on Open Collective](https://opencollective.com/Swift-Keylogger/backers/badge.svg)](https://raw.githubusercontent.com/SkrewEverything/Swift-Keylogger/master/) [![Sponsors on Open Collective](https://opencollective.com/Swift-Keylogger/sponsors/badge.svg)](https://raw.githubusercontent.com/SkrewEverything/Swift-Keylogger/master/) [![Swift 4.0](https://img.shields.io/badge/Swift-4.0-orange.svg)]()

It is a simple and easy to use keylogger for macOS. It is not meant to be malicious. There are only few keyloggers available for Mac and none of them are in Swift.

Another problem is with Apple high-level APIs. I don't know the reason but Apple suddenly deprecates and removes the documentation of APIs from its website.

So, I don't want to keep checking about the availability of their APIs and changing my code frequently. That is the reason I went for low-level API which is using HID API.

Most of the keyloggers available only log keystrokes into a file without much information about on which app the keystrokes are generated.

## Usage

Clone the repository and open the project in Xcode and build the project and run the executable.

### To run it in the background

To be able to close the Terminal when Keylogger is running, use this command while running the executable.

```shell
$ nohup ./Keylogger &
```
And you can quit the Terminal.

### To quit/stop the Keylogger

To quit the Keylogger, first, find its PID using `ps` and use `kill` to stop the keylogger.

```shell
$ ps -e | grep "Keylogger"
$ kill -9 pid_of_keylogger_from_above_command
```

When it's run, it creates folder Data
```
|--Keylogger
|--Data
    |--App
    |--Devices
    |--Key
```
Key folder stores all the keystrokes according to application.
App folder stores all the timestamps of applications being active.
Devices folder stores the information about the connected keyboards.

By default, it creates a folder where the executable is present. 
To change the path edit `bundlePathURL` in `Keylogger.swift`
##### All the data is grouped according to day in each folder.

## Integrating Swift-Keylogger with Cocoa App

There are 2 ways:

1. Using the executable(By using `Process` to call the external binaries from Cocoa App).
2. Using source code in your App without the need for external binary

### Using executable
> NOTE: The documentation of Apple has been constantly changing since the release of Swift. So, I just wanted to give the basic idea of this method without providing the code to avoid updating this part of the code frequently.

1. Clone it and build the project by yourself or download the already built binary from the releases page. 
2. Use [`Process`](https://developer.apple.com/documentation/foundation/process) to run the external binary from your app.
3. **NOTE: Don't use [`waitUntilExit()`](https://developer.apple.com/documentation/foundation/process/1415808-waituntilexit) or similar methods which can block the execution of the main UI to run the keylogger!**

### Using Source code

**1.** Add `Keylogger.swift` and `CallBackFunctions.swift` files to your project.

**2.** Initialize the Keylogger as a static variable and use `start()` and `stop()` to start and stop the keylogger.

#### Example of ViewController.swift
```swift
import Cocoa

class ViewController: NSViewController {

// Initialize the Keylogger
    static var k = Keylogger()

override func viewDidLoad() {
        super.viewDidLoad()

// Do any additional setup after loading the view.
    }

override var representedObject: Any? {
        didSet {
        // Update the view, if already loaded.
        }
    }

// A button to start the keylogger
    @IBAction func start(_ sender: Any) {
        ViewController.k.start()
    }
    
    // A button to stop the keylogger
    @IBAction func stop(_ sender: Any) {
        ViewController.k.stop()
    }
}
```

**3.** Now, to run it without any problems, turn off the **APP SANDBOX**. If you want to use **APP SANDBOX**, then add the following to your entitlements:

```
com.apple.security.device.usb = YES
```

## Disclaimer
If the use of this product causes the death of your firstborn or anyone, I'm not responsible ( no warranty, no liability, etc.)

For technical people: It is only for educational purpose.

>Note: This keylogger doesn't capture secure input fields like passwords due to [`EnableSecureEventInput`](https://developer.apple.com/library/content/technotes/tn2150/_index.html)

## Contributing

Feel free to fork the project and submit a pull request with your changes!

License
---

MIT

**Free Software, Hell Yeah!**

## Contributors

This project exists thanks to all the people who contribute. 
<a href="graphs/contributors"><img src="https://opencollective.com/Swift-Keylogger/contributors.svg?width=890&button=false" /></a>

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/Swift-Keylogger#backer)]

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/Swift-Keylogger#sponsor)]

Swift-Keylogger

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Swift-Keylogger

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README