diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b55be0b --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2021-2022 Pratyush Desai and others + +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 the author of this software nor the name of contributors to this software 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. + +Portions of the included source code are copyright by its original author(s) and remain subject to its associated license. diff --git a/README.md b/README.md index 92966f4..b2a4c12 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is a basic still WIP framework for registering an account on an ircd using ## Features -- It relies on the WIP IRCv3.2 spec [draft/account-registration](https://github.com/ProgVal/ircv3-specifications/blob/register/extensions/account-registration.md) +- It relies on the draft IRCv3 spec [draft/account-registration](https://ircv3.net/specs/extensions/account-registration.html) - It utilizes the flask framework and `WEBIRC` to relay remote host ip address. - Can be tweaked to allow registration attempts from exit-nodes and other unsavory hosts allowing them to securely work with the `require-sasl` constraint if needed. diff --git a/flaskapp.py b/flaskapp.py index a886164..4369970 100644 --- a/flaskapp.py +++ b/flaskapp.py @@ -33,6 +33,9 @@ def register(): flash("Illegal Character in Username. Please choose a different one one.") elif response == "ERR_NICKNAMEINUSE": flash("Username already taken. Please choose a different one!") + elif response == "CAP_REFUSED": + flash("This IRCd doesn't support the draft/account-registration capability") + return redirect(webchat_url) elif response == "SUCCESS": return redirect(webchat_url) else: diff --git a/forms.py b/forms.py index ea052af..e571f3c 100644 --- a/forms.py +++ b/forms.py @@ -4,6 +4,7 @@ from wtforms.validators import DataRequired, Length, EqualTo class RegistrationForm(FlaskForm): + # clarify that it conforms with casemapping on ircd. username = StringField('Username', validators=[DataRequired(), Length(min=1, max=32)]) password = PasswordField('Password', validators=[DataRequired()]) confirm_password = PasswordField('Confirm Password', validators=[DataRequired(), EqualTo('password')]) diff --git a/irc_register.py b/irc_register.py index 3fbef61..7b757f9 100644 --- a/irc_register.py +++ b/irc_register.py @@ -42,6 +42,12 @@ def ircregister(userip, username, password, email="*"): # add extra conditional for custom account and email-required _send(irctokens.build("REGISTER" ["*", password])) else: + + # REGISTER can be attempted before-connect if server supports + # but if the server responds with the corresponding FAIL we + # need to try again. We can also handle email-required using + # the same keys. How to access these key-value pairs? + # reference: https://ircv3.net/specs/extensions/account-registration.html # NICK and USER _send(irctokens.build("USER", ["u", "0", "*", username])) @@ -72,4 +78,28 @@ def ircregister(userip, username, password, email="*"): if line.command == "REGISTER" and ("SUCCESS" in line.params): to_send = irctokens.build("QUIT") _send(to_send) - return "SUCCESS" \ No newline at end of file + return "SUCCESS" + while True: + for line in lines: + print(f"< {line.format()}") + if line.command == "432": + return "ERR_ERRONEUSNICKNAME" + elif line.command == "433": + return "ERR_NICKNAMEINUSE" + _send(irctokens.build("CAP", ["REQ", "draft/account-registration"])) + if line.command == "CAP" and ("NAK" in line.params): + return "CAP_REFUSED" + elif line.command == "CAP" and ("ACK" in line.params): + to_send = irctokens.build("CAP", ["END"]) + _send(to_send) + if line.command == "PING": + to_send = irctokens.build("PONG", [line.params[0]]) + _send(to_send) + if line.command == "001": + # assuming no verif reqd. + to_send = irctokens.build("REGISTER", ["*", email, password]) + _send(to_send) + if line.command == "REGISTER" and ("SUCCESS" in line.params): + to_send = irctokens.build("QUIT") + _send(to_send) + return "SUCCESS"