From 712522d5c65db6a2b8694d57af2d89be2d00a432 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Fri, 25 Jul 2014 14:12:27 +0300 Subject: [PATCH] doc/getting_started.rst: document GPG and NickAuth --- use/getting_started.rst | 65 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/use/getting_started.rst b/use/getting_started.rst index 49edd95..7dfb52e 100644 --- a/use/getting_started.rst +++ b/use/getting_started.rst @@ -84,7 +84,9 @@ yes and then give yourself the 'owner' capability, restart the bot and you'll be ready to load some plugins! Now, in order for the bot to recognize you as your owner user, you'll have to -identify with the bot. Open up a query window in your irc client ('/query' +identify with the bot. + +Open up a query window in your irc client ('/query' should do it; if not, just know that you can't identify in a channel because it requires sending your password to the bot). Then type this:: @@ -115,6 +117,67 @@ of the person giving the command. So the command above adds the hostmask I'm currently using to my user's list of recognized hostmasks. I'm only required to give mypassword if I'm not already identified with the bot. +Limnoria +-------- + +Limnoria has two additional methods to identify. GPG and NickAuth. + +GPG +^^^ + +First you must associate your GPG key with your Limnoria account. The gpg +add command takes two arguments, key id and key server. + +My key is 0x0C207F07B2F32B67 and it's on keyserver pool.sks-keyservers.net +so and now I add it to my bot:: + + +gpg add 0x0C207F07B2F32B67 pool.sks-keyservers.net + 1 key imported, 0 unchanged, 0 not imported. + +Now I can get token to sign so I can identify:: + + +gpg gettoken + Your token is: {03640620-97ea-4fdf-b0c3-ce8fb62f2dc5}. Please sign it with your GPG key, paste it somewhere, and call the 'auth' command with the URL to the (raw) file containing the signature. + +Then I follow the instructions and sign my token in terminal:: + + echo "{03640620-97ea-4fdf-b0c3-ce8fb62f2dc5}"|gpg --clearsign|pastebinit -b sprunge.us + +Note that I used the application "pastebinit" which sends the output +directly to pastebin. If you don't have it, remove the "|pastebinit" part +and copy-paste your signature to any pastebin. I used sprunge.us, because +it only has plain text. + +And last I give the bot link to the plain text signature:: + + +gpg auth http://sprunge.us/DUdd + You are now authenticated as Mikaela. + +NickAuth +^^^^^^^^ + +This requires you to load the NickAuth plugin (see next section of this +page for loading plugins). + +NickAuth allows you to identify to the bot using your NickServ account. +First I add my NickServ accountname which I can see with "/whois Mikaela Mikaela" (because my current nick is Mikaela). It gives me something like:: + + [Mikaela] is logged in as Mikaela + +Now I tell the bot add my NickServ account Mikaela to my bot user on +freenode. The syntax is [] :: + + +nickauth nick add freenode Mikaela Mikaela + OK. + +Next time when I identify to NickServ I can use the NickAuth Auth command +to also identify to the bot:: + + +whoami + I don't recognize you. You can messsage me either of these two commands: "user identify " to log in or "user register " to register. + +nickauth auth + You are now authenticated as Mikaela. + Loading Plugins ===============