From a8ce2b9b517a083ad730ab349aaf9e84c2879e7a Mon Sep 17 00:00:00 2001 From: Bhasher Date: Tue, 26 Dec 2023 17:30:50 +0100 Subject: [PATCH] License and readme --- LICENSE.md | 7 +++++++ README.md | 13 +++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..0d9cc72 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright © 2023 Brieuc Dubois + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac0434f --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# SSH-Honeypot + +## Overview +SSH-Honeypot is a simple, effective server designed to log SSH connection attempts. It's built using Go and can be easily deployed using Docker. + +The server start a ssh server on port 22 and log any connection attempt to a logfile. + +## KISS Principles +This project adheres to the [KISS principles](https://en.wikipedia.org/wiki/KISS_principle), utilizing minimalistic and efficient codebase that focus on its core functionality. This approach avoids unnecessary complexities, ensuring the project is easy to maintain and deploy across various architectures. + + +## License +This project is licensed under the [MIT license](LICENSE.md).