https://github.com/mitchr/gossip

an irc server
https://github.com/mitchr/gossip

irc ircv3 sasl tls

Last synced: 5 months ago
JSON representation

an irc server

Host: GitHub
URL: https://github.com/mitchr/gossip
Owner: mitchr
License: gpl-3.0
Created: 2020-07-03T16:11:03.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-01-13T19:17:07.000Z (over 2 years ago)
Last Synced: 2024-01-14T05:14:46.133Z (over 2 years ago)
Topics: irc, ircv3, sasl, tls
Language: Go
Homepage:
Size: 652 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

README

# `gossip` ![build status](https://github.com/mitchr/gossip/actions/workflows/go.yml/badge.svg)
`gossip` is an IRC server.

## Install
`go install github.com/mitchr/gossip@latest`

## Usage
`gossip` by default looks for a file in the same directory as it called [config.json](config.json). You can change this location by using `gossip -conf=` This defines things like the name of the server and the port. To use TLS, you have to specify paths to `pubkey` and `privkey`.

To add a server password, use `gossip -s`. This will prompt you to enter a password and then save the bcrypt-ed hash in `config.json`. Similarly to add a new server operator, you can use `gossip -o`.

You can register an account using `REGISTER PASS `. By default, `REGISTER` uses your current nick as the username. If you are connected with a client tls certificate, `REGISTER CERT` will grab its fingerprint and use that for authentication. User accounts only support SASL authentication, so you must use `PLAIN` or `SCRAM-SHA-256` for passwords, or `EXTERNAL` for certificate authentication. User accounts are by default stored in an in-memory sqlite database. You can specify a specific db file by changing the `datasource` config property.

## References
- [RFC 1459](https://datatracker.ietf.org/doc/html/rfc1459)
- [RFC 2812](https://datatracker.ietf.org/doc/html/rfc2812)
- [IRCv3](https://ircv3.net/irc/)
- [Modern IRC Client Protocol](https://modern.ircdocs.horse/)
- [irctest](https://github.com/progval/irctest)
- [gossip.py](gossip.py) has been modified from the [ergo](https://github.com/progval/irctest/blob/master/irctest/controllers/ergo.py) controller to support gossip, and is how a lot of bugs have been found :)
- [parser-tests](https://github.com/ircdocs/parser-tests)

## External Licenses
`golang.org/x/crypto` and `golang.org/x/term` are licensed under the BSD-3-Clause, reproduced below

```
Copyright (c) 2009 The Go Authors. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```

`modernc.org/sqlite` is licensed under the BSD-3 clause, reproduced below

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```

`google/uuid` is licensed under the BSD-3 clause, reproduced below

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mitchr/gossip

Awesome Lists containing this project

README