You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

server.go 38KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084
  1. // Copyright (c) 2012-2014 Jeremy Latt
  2. // Copyright (c) 2014-2015 Edmund Huber
  3. // Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
  4. // released under the MIT license
  5. package irc
  6. import (
  7. "fmt"
  8. "net"
  9. "net/http"
  10. _ "net/http/pprof"
  11. "os"
  12. "os/signal"
  13. "runtime/debug"
  14. "strconv"
  15. "strings"
  16. "sync"
  17. "syscall"
  18. "time"
  19. "unsafe"
  20. "github.com/ergochat/irc-go/ircfmt"
  21. "github.com/okzk/sdnotify"
  22. "github.com/ergochat/ergo/irc/caps"
  23. "github.com/ergochat/ergo/irc/connection_limits"
  24. "github.com/ergochat/ergo/irc/flatip"
  25. "github.com/ergochat/ergo/irc/history"
  26. "github.com/ergochat/ergo/irc/logger"
  27. "github.com/ergochat/ergo/irc/modes"
  28. "github.com/ergochat/ergo/irc/mysql"
  29. "github.com/ergochat/ergo/irc/sno"
  30. "github.com/ergochat/ergo/irc/utils"
  31. "github.com/tidwall/buntdb"
  32. )
  33. const (
  34. alwaysOnExpirationPollPeriod = time.Hour
  35. )
  36. var (
  37. // common error line to sub values into
  38. errorMsg = "ERROR :%s\r\n"
  39. // three final parameters of 004 RPL_MYINFO, enumerating our supported modes
  40. rplMyInfo1, rplMyInfo2, rplMyInfo3 = modes.RplMyInfo()
  41. // CHANMODES isupport token
  42. chanmodesToken = modes.ChanmodesToken()
  43. // whitelist of caps to serve on the STS-only listener. In particular,
  44. // never advertise SASL, to discourage people from sending their passwords:
  45. stsOnlyCaps = caps.NewSet(caps.STS, caps.MessageTags, caps.ServerTime, caps.Batch, caps.LabeledResponse, caps.EchoMessage, caps.Nope)
  46. // we only have standard channels for now. TODO: any updates to this
  47. // will also need to be reflected in CasefoldChannel
  48. chanTypes = "#"
  49. throttleMessage = "You have attempted to connect too many times within a short duration. Wait a while, and you will be able to connect."
  50. )
  51. // Server is the main Oragono server.
  52. type Server struct {
  53. accounts AccountManager
  54. channels ChannelManager
  55. channelRegistry ChannelRegistry
  56. clients ClientManager
  57. config unsafe.Pointer
  58. configFilename string
  59. connectionLimiter connection_limits.Limiter
  60. ctime time.Time
  61. dlines *DLineManager
  62. helpIndexManager HelpIndexManager
  63. klines *KLineManager
  64. listeners map[string]IRCListener
  65. logger *logger.Manager
  66. monitorManager MonitorManager
  67. name string
  68. nameCasefolded string
  69. rehashMutex sync.Mutex // tier 4
  70. rehashSignal chan os.Signal
  71. pprofServer *http.Server
  72. exitSignals chan os.Signal
  73. snomasks SnoManager
  74. store *buntdb.DB
  75. historyDB mysql.MySQL
  76. torLimiter connection_limits.TorLimiter
  77. whoWas WhoWasList
  78. stats Stats
  79. semaphores ServerSemaphores
  80. defcon uint32
  81. }
  82. // NewServer returns a new Oragono server.
  83. func NewServer(config *Config, logger *logger.Manager) (*Server, error) {
  84. // initialize data structures
  85. server := &Server{
  86. ctime: time.Now().UTC(),
  87. listeners: make(map[string]IRCListener),
  88. logger: logger,
  89. rehashSignal: make(chan os.Signal, 1),
  90. exitSignals: make(chan os.Signal, len(ServerExitSignals)),
  91. defcon: 5,
  92. }
  93. server.clients.Initialize()
  94. server.semaphores.Initialize()
  95. server.whoWas.Initialize(config.Limits.WhowasEntries)
  96. server.monitorManager.Initialize()
  97. server.snomasks.Initialize()
  98. if err := server.applyConfig(config); err != nil {
  99. return nil, err
  100. }
  101. // Attempt to clean up when receiving these signals.
  102. signal.Notify(server.exitSignals, ServerExitSignals...)
  103. signal.Notify(server.rehashSignal, syscall.SIGHUP)
  104. time.AfterFunc(alwaysOnExpirationPollPeriod, server.handleAlwaysOnExpirations)
  105. return server, nil
  106. }
  107. // Shutdown shuts down the server.
  108. func (server *Server) Shutdown() {
  109. sdnotify.Stopping()
  110. server.logger.Info("server", "Stopping server")
  111. //TODO(dan): Make sure we disallow new nicks
  112. for _, client := range server.clients.AllClients() {
  113. client.Notice("Server is shutting down")
  114. if client.AlwaysOn() {
  115. client.Store(IncludeLastSeen)
  116. }
  117. }
  118. if err := server.store.Close(); err != nil {
  119. server.logger.Error("shutdown", fmt.Sprintln("Could not close datastore:", err))
  120. }
  121. server.historyDB.Close()
  122. server.logger.Info("server", fmt.Sprintf("%s exiting", Ver))
  123. }
  124. // Run starts the server.
  125. func (server *Server) Run() {
  126. defer server.Shutdown()
  127. for {
  128. select {
  129. case <-server.exitSignals:
  130. return
  131. case <-server.rehashSignal:
  132. server.logger.Info("server", "Rehashing due to SIGHUP")
  133. go server.rehash()
  134. }
  135. }
  136. }
  137. func (server *Server) checkBans(config *Config, ipaddr net.IP, checkScripts bool) (banned bool, requireSASL bool, message string) {
  138. // #671: do not enforce bans against loopback, as a failsafe
  139. // note that this function is not used for Tor connections (checkTorLimits is used instead)
  140. if ipaddr.IsLoopback() {
  141. return
  142. }
  143. if server.Defcon() == 1 {
  144. if !utils.IPInNets(ipaddr, server.Config().Server.secureNets) {
  145. return true, false, "New connections to this server are temporarily restricted"
  146. }
  147. }
  148. flat := flatip.FromNetIP(ipaddr)
  149. // check DLINEs
  150. isBanned, info := server.dlines.CheckIP(flat)
  151. if isBanned {
  152. if info.RequireSASL {
  153. server.logger.Info("connect-ip", "Requiring SASL from client due to d-line", ipaddr.String())
  154. return false, true, info.BanMessage("You must authenticate with SASL to connect from this IP (%s)")
  155. } else {
  156. server.logger.Info("connect-ip", "Client rejected by d-line", ipaddr.String())
  157. return true, false, info.BanMessage("You are banned from this server (%s)")
  158. }
  159. }
  160. // check connection limits
  161. err := server.connectionLimiter.AddClient(flat)
  162. if err == connection_limits.ErrLimitExceeded {
  163. // too many connections from one client, tell the client and close the connection
  164. server.logger.Info("connect-ip", "Client rejected for connection limit", ipaddr.String())
  165. return true, false, "Too many clients from your network"
  166. } else if err == connection_limits.ErrThrottleExceeded {
  167. server.logger.Info("connect-ip", "Client exceeded connection throttle", ipaddr.String())
  168. return true, false, throttleMessage
  169. } else if err != nil {
  170. server.logger.Warning("internal", "unexpected ban result", err.Error())
  171. }
  172. if checkScripts && config.Server.IPCheckScript.Enabled {
  173. output, err := CheckIPBan(server.semaphores.IPCheckScript, config.Server.IPCheckScript, ipaddr)
  174. if err != nil {
  175. server.logger.Error("internal", "couldn't check IP ban script", ipaddr.String(), err.Error())
  176. return false, false, ""
  177. }
  178. // TODO: currently no way to cache IPAccepted
  179. if (output.Result == IPBanned || output.Result == IPRequireSASL) && output.CacheSeconds != 0 {
  180. network, err := flatip.ParseToNormalizedNet(output.CacheNet)
  181. if err != nil {
  182. server.logger.Error("internal", "invalid dline net from IP ban script", ipaddr.String(), output.CacheNet)
  183. } else {
  184. dlineDuration := time.Duration(output.CacheSeconds) * time.Second
  185. err := server.dlines.AddNetwork(network, dlineDuration, output.Result == IPRequireSASL, output.BanMessage, "", "")
  186. if err != nil {
  187. server.logger.Error("internal", "couldn't set dline from IP ban script", ipaddr.String(), err.Error())
  188. }
  189. }
  190. }
  191. if output.Result == IPBanned {
  192. // XXX roll back IP connection/throttling addition for the IP
  193. server.connectionLimiter.RemoveClient(flat)
  194. server.logger.Info("connect-ip", "Rejected client due to ip-check-script", ipaddr.String())
  195. return true, false, output.BanMessage
  196. } else if output.Result == IPRequireSASL {
  197. server.logger.Info("connect-ip", "Requiring SASL from client due to ip-check-script", ipaddr.String())
  198. return false, true, output.BanMessage
  199. }
  200. }
  201. return false, false, ""
  202. }
  203. func (server *Server) checkTorLimits() (banned bool, message string) {
  204. switch server.torLimiter.AddClient() {
  205. case connection_limits.ErrLimitExceeded:
  206. return true, "Too many clients from the Tor network"
  207. case connection_limits.ErrThrottleExceeded:
  208. return true, "Exceeded connection throttle for the Tor network"
  209. default:
  210. return false, ""
  211. }
  212. }
  213. func (server *Server) handleAlwaysOnExpirations() {
  214. defer func() {
  215. if r := recover(); r != nil {
  216. server.logger.Error("internal",
  217. fmt.Sprintf("Panic in always-on cleanup: %v\n%s", r, debug.Stack()))
  218. }
  219. // either way, reschedule
  220. time.AfterFunc(alwaysOnExpirationPollPeriod, server.handleAlwaysOnExpirations)
  221. }()
  222. config := server.Config()
  223. deadline := time.Duration(config.Accounts.Multiclient.AlwaysOnExpiration)
  224. if deadline == 0 {
  225. return
  226. }
  227. server.logger.Info("accounts", "Checking always-on clients for expiration")
  228. for _, client := range server.clients.AllClients() {
  229. if client.IsExpiredAlwaysOn(config) {
  230. // TODO save the channels list, use it for autojoin if/when they return?
  231. server.logger.Info("accounts", "Expiring always-on client", client.AccountName())
  232. client.destroy(nil)
  233. }
  234. }
  235. }
  236. //
  237. // server functionality
  238. //
  239. func (server *Server) tryRegister(c *Client, session *Session) (exiting bool) {
  240. // XXX PROXY or WEBIRC MUST be sent as the first line of the session;
  241. // if we are here at all that means we have the final value of the IP
  242. if session.rawHostname == "" {
  243. session.client.lookupHostname(session, false)
  244. }
  245. // try to complete registration normally
  246. // XXX(#1057) username can be filled in by an ident query without the client
  247. // having sent USER: check for both username and realname to ensure they did
  248. if c.preregNick == "" || c.username == "" || c.realname == "" || session.capState == caps.NegotiatingState {
  249. return
  250. }
  251. if c.isSTSOnly {
  252. server.playSTSBurst(session)
  253. return true
  254. }
  255. // client MUST send PASS if necessary, or authenticate with SASL if necessary,
  256. // before completing the other registration commands
  257. config := server.Config()
  258. authOutcome := c.isAuthorized(server, config, session, c.requireSASL)
  259. var quitMessage string
  260. switch authOutcome {
  261. case authFailPass:
  262. quitMessage = c.t("Password incorrect")
  263. c.Send(nil, server.name, ERR_PASSWDMISMATCH, "*", quitMessage)
  264. case authFailSaslRequired, authFailTorSaslRequired:
  265. quitMessage = c.requireSASLMessage
  266. if quitMessage == "" {
  267. quitMessage = c.t("You must log in with SASL to join this server")
  268. }
  269. c.Send(nil, c.server.name, "FAIL", "*", "ACCOUNT_REQUIRED", quitMessage)
  270. }
  271. if authOutcome != authSuccess {
  272. c.Quit(quitMessage, nil)
  273. return true
  274. }
  275. c.requireSASLMessage = ""
  276. rb := NewResponseBuffer(session)
  277. nickError := performNickChange(server, c, c, session, c.preregNick, rb)
  278. rb.Send(true)
  279. if nickError == errInsecureReattach {
  280. c.Quit(c.t("You can't mix secure and insecure connections to this account"), nil)
  281. return true
  282. } else if nickError != nil {
  283. c.preregNick = ""
  284. return false
  285. }
  286. if session.client != c {
  287. // reattached, bail out.
  288. // we'll play the reg burst later, on the new goroutine associated with
  289. // (thisSession, otherClient). This is to avoid having to transfer state
  290. // like nickname, hostname, etc. to show the correct values in the reg burst.
  291. return false
  292. }
  293. // Apply default user modes (without updating the invisible counter)
  294. // The number of invisible users will be updated by server.stats.Register
  295. // if we're using default user mode +i.
  296. for _, defaultMode := range config.Accounts.defaultUserModes {
  297. c.SetMode(defaultMode, true)
  298. }
  299. // count new user in statistics (before checking KLINEs, see #1303)
  300. server.stats.Register(c.HasMode(modes.Invisible))
  301. // check KLINEs (#671: ignore KLINEs for loopback connections)
  302. if !session.IP().IsLoopback() || session.isTor {
  303. isBanned, info := server.klines.CheckMasks(c.AllNickmasks()...)
  304. if isBanned {
  305. c.Quit(info.BanMessage(c.t("You are banned from this server (%s)")), nil)
  306. return true
  307. }
  308. }
  309. server.playRegistrationBurst(session)
  310. return false
  311. }
  312. func (server *Server) playSTSBurst(session *Session) {
  313. nick := utils.SafeErrorParam(session.client.preregNick)
  314. session.Send(nil, server.name, RPL_WELCOME, nick, fmt.Sprintf("Welcome to the Internet Relay Network %s", nick))
  315. session.Send(nil, server.name, RPL_YOURHOST, nick, fmt.Sprintf("Your host is %[1]s, running version %[2]s", server.name, "ergo"))
  316. session.Send(nil, server.name, RPL_CREATED, nick, fmt.Sprintf("This server was created %s", time.Time{}.Format(time.RFC1123)))
  317. session.Send(nil, server.name, RPL_MYINFO, nick, server.name, "ergo", "o", "o", "o")
  318. session.Send(nil, server.name, RPL_ISUPPORT, nick, "CASEMAPPING=ascii", "are supported by this server")
  319. session.Send(nil, server.name, ERR_NOMOTD, nick, "MOTD is unavailable")
  320. for _, line := range server.Config().Server.STS.bannerLines {
  321. session.Send(nil, server.name, "NOTICE", nick, line)
  322. }
  323. }
  324. func (server *Server) playRegistrationBurst(session *Session) {
  325. c := session.client
  326. // continue registration
  327. d := c.Details()
  328. server.logger.Info("connect", fmt.Sprintf("Client connected [%s] [u:%s] [r:%s]", d.nick, d.username, d.realname))
  329. server.snomasks.Send(sno.LocalConnects, fmt.Sprintf("Client connected [%s] [u:%s] [h:%s] [ip:%s] [r:%s]", d.nick, d.username, session.rawHostname, session.IP().String(), d.realname))
  330. if d.account != "" {
  331. server.sendLoginSnomask(d.nickMask, d.accountName)
  332. }
  333. // send welcome text
  334. //NOTE(dan): we specifically use the NICK here instead of the nickmask
  335. // see http://modern.ircdocs.horse/#rplwelcome-001 for details on why we avoid using the nickmask
  336. config := server.Config()
  337. session.Send(nil, server.name, RPL_WELCOME, d.nick, fmt.Sprintf(c.t("Welcome to the %s IRC Network %s"), config.Network.Name, d.nick))
  338. session.Send(nil, server.name, RPL_YOURHOST, d.nick, fmt.Sprintf(c.t("Your host is %[1]s, running version %[2]s"), server.name, Ver))
  339. session.Send(nil, server.name, RPL_CREATED, d.nick, fmt.Sprintf(c.t("This server was created %s"), server.ctime.Format(time.RFC1123)))
  340. session.Send(nil, server.name, RPL_MYINFO, d.nick, server.name, Ver, rplMyInfo1, rplMyInfo2, rplMyInfo3)
  341. rb := NewResponseBuffer(session)
  342. server.RplISupport(c, rb)
  343. server.Lusers(c, rb)
  344. server.MOTD(c, rb)
  345. rb.Send(true)
  346. modestring := c.ModeString()
  347. if modestring != "+" {
  348. session.Send(nil, server.name, RPL_UMODEIS, d.nick, modestring)
  349. }
  350. c.attemptAutoOper(session)
  351. if server.logger.IsLoggingRawIO() {
  352. session.Send(nil, c.server.name, "NOTICE", d.nick, c.t("This server is in debug mode and is logging all user I/O. If you do not wish for everything you send to be readable by the server owner(s), please disconnect."))
  353. }
  354. }
  355. // RplISupport outputs our ISUPPORT lines to the client. This is used on connection and in VERSION responses.
  356. func (server *Server) RplISupport(client *Client, rb *ResponseBuffer) {
  357. translatedISupport := client.t("are supported by this server")
  358. nick := client.Nick()
  359. config := server.Config()
  360. for _, cachedTokenLine := range config.Server.isupport.CachedReply {
  361. length := len(cachedTokenLine) + 2
  362. tokenline := make([]string, length)
  363. tokenline[0] = nick
  364. copy(tokenline[1:], cachedTokenLine)
  365. tokenline[length-1] = translatedISupport
  366. rb.Add(nil, server.name, RPL_ISUPPORT, tokenline...)
  367. }
  368. }
  369. func (server *Server) Lusers(client *Client, rb *ResponseBuffer) {
  370. nick := client.Nick()
  371. stats := server.stats.GetValues()
  372. rb.Add(nil, server.name, RPL_LUSERCLIENT, nick, fmt.Sprintf(client.t("There are %[1]d users and %[2]d invisible on %[3]d server(s)"), stats.Total-stats.Invisible, stats.Invisible, 1))
  373. rb.Add(nil, server.name, RPL_LUSEROP, nick, strconv.Itoa(stats.Operators), client.t("IRC Operators online"))
  374. rb.Add(nil, server.name, RPL_LUSERUNKNOWN, nick, strconv.Itoa(stats.Unknown), client.t("unregistered connections"))
  375. rb.Add(nil, server.name, RPL_LUSERCHANNELS, nick, strconv.Itoa(server.channels.Len()), client.t("channels formed"))
  376. rb.Add(nil, server.name, RPL_LUSERME, nick, fmt.Sprintf(client.t("I have %[1]d clients and %[2]d servers"), stats.Total, 0))
  377. total := strconv.Itoa(stats.Total)
  378. max := strconv.Itoa(stats.Max)
  379. rb.Add(nil, server.name, RPL_LOCALUSERS, nick, total, max, fmt.Sprintf(client.t("Current local users %[1]s, max %[2]s"), total, max))
  380. rb.Add(nil, server.name, RPL_GLOBALUSERS, nick, total, max, fmt.Sprintf(client.t("Current global users %[1]s, max %[2]s"), total, max))
  381. }
  382. // MOTD serves the Message of the Day.
  383. func (server *Server) MOTD(client *Client, rb *ResponseBuffer) {
  384. motdLines := server.Config().Server.motdLines
  385. if len(motdLines) < 1 {
  386. rb.Add(nil, server.name, ERR_NOMOTD, client.nick, client.t("MOTD File is missing"))
  387. return
  388. }
  389. rb.Add(nil, server.name, RPL_MOTDSTART, client.nick, fmt.Sprintf(client.t("- %s Message of the day - "), server.name))
  390. for _, line := range motdLines {
  391. rb.Add(nil, server.name, RPL_MOTD, client.nick, line)
  392. }
  393. rb.Add(nil, server.name, RPL_ENDOFMOTD, client.nick, client.t("End of MOTD command"))
  394. }
  395. func (client *Client) whoisChannelsNames(target *Client, multiPrefix bool, hasPrivs bool) []string {
  396. var chstrs []string
  397. targetInvis := target.HasMode(modes.Invisible)
  398. for _, channel := range target.Channels() {
  399. if !hasPrivs && (targetInvis || channel.flags.HasMode(modes.Secret)) && !channel.hasClient(client) {
  400. // client can't see *this* channel membership
  401. continue
  402. }
  403. chstrs = append(chstrs, channel.ClientPrefixes(target, multiPrefix)+channel.name)
  404. }
  405. return chstrs
  406. }
  407. func (client *Client) getWhoisOf(target *Client, hasPrivs bool, rb *ResponseBuffer) {
  408. oper := client.Oper()
  409. cnick := client.Nick()
  410. targetInfo := target.Details()
  411. rb.Add(nil, client.server.name, RPL_WHOISUSER, cnick, targetInfo.nick, targetInfo.username, targetInfo.hostname, "*", targetInfo.realname)
  412. tnick := targetInfo.nick
  413. whoischannels := client.whoisChannelsNames(target, rb.session.capabilities.Has(caps.MultiPrefix), oper.HasRoleCapab("sajoin"))
  414. if whoischannels != nil {
  415. rb.Add(nil, client.server.name, RPL_WHOISCHANNELS, cnick, tnick, strings.Join(whoischannels, " "))
  416. }
  417. if target.HasMode(modes.Operator) && operStatusVisible(client, target, oper != nil) {
  418. tOper := target.Oper()
  419. if tOper != nil {
  420. rb.Add(nil, client.server.name, RPL_WHOISOPERATOR, cnick, tnick, tOper.WhoisLine)
  421. }
  422. }
  423. if client == target || oper.HasRoleCapab("ban") {
  424. ip, hostname := target.getWhoisActually()
  425. rb.Add(nil, client.server.name, RPL_WHOISACTUALLY, cnick, tnick, fmt.Sprintf("%s@%s", targetInfo.username, hostname), utils.IPStringToHostname(ip.String()), client.t("Actual user@host, Actual IP"))
  426. }
  427. if client == target || oper.HasRoleCapab("samode") {
  428. rb.Add(nil, client.server.name, RPL_WHOISMODES, cnick, tnick, fmt.Sprintf(client.t("is using modes +%s"), target.modes.String()))
  429. }
  430. if target.HasMode(modes.TLS) {
  431. rb.Add(nil, client.server.name, RPL_WHOISSECURE, cnick, tnick, client.t("is using a secure connection"))
  432. }
  433. if targetInfo.accountName != "*" {
  434. rb.Add(nil, client.server.name, RPL_WHOISACCOUNT, cnick, tnick, targetInfo.accountName, client.t("is logged in as"))
  435. }
  436. if target.HasMode(modes.Bot) {
  437. rb.Add(nil, client.server.name, RPL_WHOISBOT, cnick, tnick, fmt.Sprintf(ircfmt.Unescape(client.t("is a $bBot$b on %s")), client.server.Config().Network.Name))
  438. }
  439. if client == target || oper.HasRoleCapab("ban") {
  440. for _, session := range target.Sessions() {
  441. if session.certfp != "" {
  442. rb.Add(nil, client.server.name, RPL_WHOISCERTFP, cnick, tnick, fmt.Sprintf(client.t("has client certificate fingerprint %s"), session.certfp))
  443. }
  444. }
  445. }
  446. rb.Add(nil, client.server.name, RPL_WHOISIDLE, cnick, tnick, strconv.FormatUint(target.IdleSeconds(), 10), strconv.FormatInt(target.SignonTime(), 10), client.t("seconds idle, signon time"))
  447. if away, awayMessage := target.Away(); away {
  448. rb.Add(nil, client.server.name, RPL_AWAY, cnick, tnick, awayMessage)
  449. }
  450. }
  451. // rehash reloads the config and applies the changes from the config file.
  452. func (server *Server) rehash() error {
  453. // #1570; this needs its own panic handling because it can be invoked via SIGHUP
  454. defer func() {
  455. if r := recover(); r != nil {
  456. if server.Config().Debug.recoverFromErrors {
  457. server.logger.Error("internal",
  458. fmt.Sprintf("Panic during rehash: %v\n%s", r, debug.Stack()))
  459. } else {
  460. panic(r)
  461. }
  462. }
  463. }()
  464. server.logger.Info("server", "Attempting rehash")
  465. // only let one REHASH go on at a time
  466. server.rehashMutex.Lock()
  467. defer server.rehashMutex.Unlock()
  468. sdnotify.Reloading()
  469. defer sdnotify.Ready()
  470. config, err := LoadConfig(server.configFilename)
  471. if err != nil {
  472. server.logger.Error("server", "failed to load config file", err.Error())
  473. return err
  474. }
  475. err = server.applyConfig(config)
  476. if err != nil {
  477. server.logger.Error("server", "Failed to rehash", err.Error())
  478. return err
  479. }
  480. server.logger.Info("server", "Rehash completed successfully")
  481. return nil
  482. }
  483. func (server *Server) applyConfig(config *Config) (err error) {
  484. oldConfig := server.Config()
  485. initial := oldConfig == nil
  486. if initial {
  487. server.configFilename = config.Filename
  488. server.name = config.Server.Name
  489. server.nameCasefolded = config.Server.nameCasefolded
  490. globalCasemappingSetting = config.Server.Casemapping
  491. globalUtf8EnforcementSetting = config.Server.EnforceUtf8
  492. MaxLineLen = config.Server.MaxLineLen
  493. } else {
  494. // enforce configs that can't be changed after launch:
  495. if server.name != config.Server.Name {
  496. return fmt.Errorf("Server name cannot be changed after launching the server, rehash aborted")
  497. } else if oldConfig.Datastore.Path != config.Datastore.Path {
  498. return fmt.Errorf("Datastore path cannot be changed after launching the server, rehash aborted")
  499. } else if globalCasemappingSetting != config.Server.Casemapping {
  500. return fmt.Errorf("Casemapping cannot be changed after launching the server, rehash aborted")
  501. } else if globalUtf8EnforcementSetting != config.Server.EnforceUtf8 {
  502. return fmt.Errorf("UTF-8 enforcement cannot be changed after launching the server, rehash aborted")
  503. } else if oldConfig.Accounts.Multiclient.AlwaysOn != config.Accounts.Multiclient.AlwaysOn {
  504. return fmt.Errorf("Default always-on setting cannot be changed after launching the server, rehash aborted")
  505. } else if oldConfig.Server.Relaymsg.Enabled != config.Server.Relaymsg.Enabled {
  506. return fmt.Errorf("Cannot enable or disable relaying after launching the server, rehash aborted")
  507. } else if oldConfig.Server.Relaymsg.Separators != config.Server.Relaymsg.Separators {
  508. return fmt.Errorf("Cannot change relaying separators after launching the server, rehash aborted")
  509. } else if oldConfig.Server.IPCheckScript.MaxConcurrency != config.Server.IPCheckScript.MaxConcurrency ||
  510. oldConfig.Accounts.AuthScript.MaxConcurrency != config.Accounts.AuthScript.MaxConcurrency {
  511. return fmt.Errorf("Cannot change max-concurrency for scripts after launching the server, rehash aborted")
  512. } else if oldConfig.Server.OverrideServicesHostname != config.Server.OverrideServicesHostname {
  513. return fmt.Errorf("Cannot change override-services-hostname after launching the server, rehash aborted")
  514. } else if !oldConfig.Datastore.MySQL.Enabled && config.Datastore.MySQL.Enabled {
  515. return fmt.Errorf("Cannot enable MySQL after launching the server, rehash aborted")
  516. } else if oldConfig.Server.MaxLineLen != config.Server.MaxLineLen {
  517. return fmt.Errorf("Cannot change max-line-len after launching the server, rehash aborted")
  518. }
  519. }
  520. server.logger.Info("server", "Using config file", server.configFilename)
  521. // first, reload config sections for functionality implemented in subpackages:
  522. wasLoggingRawIO := !initial && server.logger.IsLoggingRawIO()
  523. err = server.logger.ApplyConfig(config.Logging)
  524. if err != nil {
  525. return err
  526. }
  527. nowLoggingRawIO := server.logger.IsLoggingRawIO()
  528. // notify existing clients if raw i/o logging was enabled by a rehash
  529. sendRawOutputNotice := !wasLoggingRawIO && nowLoggingRawIO
  530. server.connectionLimiter.ApplyConfig(&config.Server.IPLimits)
  531. tlConf := &config.Server.TorListeners
  532. server.torLimiter.Configure(tlConf.MaxConnections, tlConf.ThrottleDuration, tlConf.MaxConnectionsPerDuration)
  533. // Translations
  534. server.logger.Debug("server", "Regenerating HELP indexes for new languages")
  535. server.helpIndexManager.GenerateIndices(config.languageManager)
  536. if initial {
  537. maxIPConc := int(config.Server.IPCheckScript.MaxConcurrency)
  538. if maxIPConc != 0 {
  539. server.semaphores.IPCheckScript = utils.NewSemaphore(maxIPConc)
  540. }
  541. maxAuthConc := int(config.Accounts.AuthScript.MaxConcurrency)
  542. if maxAuthConc != 0 {
  543. server.semaphores.AuthScript = utils.NewSemaphore(maxAuthConc)
  544. }
  545. if err := overrideServicePrefixes(config.Server.OverrideServicesHostname); err != nil {
  546. return err
  547. }
  548. }
  549. if oldConfig != nil {
  550. // if certain features were enabled by rehash, we need to load the corresponding data
  551. // from the store
  552. if !oldConfig.Accounts.NickReservation.Enabled {
  553. server.accounts.buildNickToAccountIndex(config)
  554. }
  555. if !oldConfig.Channels.Registration.Enabled {
  556. server.channels.loadRegisteredChannels(config)
  557. }
  558. // resize history buffers as needed
  559. if config.historyChangedFrom(oldConfig) {
  560. for _, channel := range server.channels.Channels() {
  561. channel.resizeHistory(config)
  562. }
  563. for _, client := range server.clients.AllClients() {
  564. client.resizeHistory(config)
  565. }
  566. }
  567. if oldConfig.Accounts.Registration.Throttling != config.Accounts.Registration.Throttling {
  568. server.accounts.resetRegisterThrottle(config)
  569. }
  570. }
  571. server.logger.Info("server", "Using datastore", config.Datastore.Path)
  572. if initial {
  573. if err := server.loadDatastore(config); err != nil {
  574. return err
  575. }
  576. } else {
  577. if config.Datastore.MySQL.Enabled && config.Datastore.MySQL != oldConfig.Datastore.MySQL {
  578. server.historyDB.SetConfig(config.Datastore.MySQL)
  579. }
  580. }
  581. // now that the datastore is initialized, we can load the cloak secret from it
  582. // XXX this modifies config after the initial load, which is naughty,
  583. // but there's no data race because we haven't done SetConfig yet
  584. config.Server.Cloaks.SetSecret(LoadCloakSecret(server.store))
  585. // activate the new config
  586. server.SetConfig(config)
  587. // load [dk]-lines, registered users and channels, etc.
  588. if initial {
  589. if err := server.loadFromDatastore(config); err != nil {
  590. return err
  591. }
  592. }
  593. // burst new and removed caps
  594. addedCaps, removedCaps := config.Diff(oldConfig)
  595. var capBurstSessions []*Session
  596. added := make(map[caps.Version][]string)
  597. var removed []string
  598. if !addedCaps.Empty() || !removedCaps.Empty() {
  599. capBurstSessions = server.clients.AllWithCapsNotify()
  600. added[caps.Cap301] = addedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  601. added[caps.Cap302] = addedCaps.Strings(caps.Cap302, config.Server.capValues, 0)
  602. // removed never has values, so we leave it as Cap301
  603. removed = removedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  604. }
  605. for _, sSession := range capBurstSessions {
  606. // DEL caps and then send NEW ones so that updated caps get removed/added correctly
  607. if !removedCaps.Empty() {
  608. for _, capStr := range removed {
  609. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "DEL", capStr)
  610. }
  611. }
  612. if !addedCaps.Empty() {
  613. for _, capStr := range added[sSession.capVersion] {
  614. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "NEW", capStr)
  615. }
  616. }
  617. }
  618. server.setupPprofListener(config)
  619. // set RPL_ISUPPORT
  620. var newISupportReplies [][]string
  621. if oldConfig != nil {
  622. newISupportReplies = oldConfig.Server.isupport.GetDifference(&config.Server.isupport)
  623. }
  624. if len(config.Server.ProxyAllowedFrom) != 0 {
  625. server.logger.Info("server", "Proxied IPs will be accepted from", strings.Join(config.Server.ProxyAllowedFrom, ", "))
  626. }
  627. // we are now ready to receive connections:
  628. err = server.setupListeners(config)
  629. if initial && err == nil {
  630. server.logger.Info("server", "Server running")
  631. sdnotify.Ready()
  632. }
  633. if !initial {
  634. // push new info to all of our clients
  635. for _, sClient := range server.clients.AllClients() {
  636. for _, tokenline := range newISupportReplies {
  637. sClient.Send(nil, server.name, RPL_ISUPPORT, append([]string{sClient.nick}, tokenline...)...)
  638. }
  639. if sendRawOutputNotice {
  640. sClient.Notice(sClient.t("This server is in debug mode and is logging all user I/O. If you do not wish for everything you send to be readable by the server owner(s), please disconnect."))
  641. }
  642. }
  643. }
  644. // send other config warnings
  645. if config.Accounts.RequireSasl.Enabled && config.Accounts.Registration.Enabled {
  646. server.logger.Warning("server", "Warning: although require-sasl is enabled, users can still register accounts. If your server is not intended to be public, you must set accounts.registration.enabled to false.")
  647. }
  648. return err
  649. }
  650. func (server *Server) setupPprofListener(config *Config) {
  651. pprofListener := ""
  652. if config.Debug.PprofListener != nil {
  653. pprofListener = *config.Debug.PprofListener
  654. }
  655. if server.pprofServer != nil {
  656. if pprofListener == "" || (pprofListener != server.pprofServer.Addr) {
  657. server.logger.Info("server", "Stopping pprof listener", server.pprofServer.Addr)
  658. server.pprofServer.Close()
  659. server.pprofServer = nil
  660. }
  661. }
  662. if pprofListener != "" && server.pprofServer == nil {
  663. ps := http.Server{
  664. Addr: pprofListener,
  665. }
  666. go func() {
  667. if err := ps.ListenAndServe(); err != nil {
  668. server.logger.Error("server", "pprof listener failed", err.Error())
  669. }
  670. }()
  671. server.pprofServer = &ps
  672. server.logger.Info("server", "Started pprof listener", server.pprofServer.Addr)
  673. }
  674. }
  675. func (server *Server) loadDatastore(config *Config) error {
  676. // open the datastore and load server state for which it (rather than config)
  677. // is the source of truth
  678. _, err := os.Stat(config.Datastore.Path)
  679. if os.IsNotExist(err) {
  680. server.logger.Warning("server", "database does not exist, creating it", config.Datastore.Path)
  681. err = initializeDB(config.Datastore.Path)
  682. if err != nil {
  683. return err
  684. }
  685. }
  686. db, err := OpenDatabase(config)
  687. if err == nil {
  688. server.store = db
  689. return nil
  690. } else {
  691. return fmt.Errorf("Failed to open datastore: %s", err.Error())
  692. }
  693. }
  694. func (server *Server) loadFromDatastore(config *Config) (err error) {
  695. // load *lines (from the datastores)
  696. server.logger.Debug("server", "Loading D/Klines")
  697. server.loadDLines()
  698. server.loadKLines()
  699. server.channelRegistry.Initialize(server)
  700. server.channels.Initialize(server)
  701. server.accounts.Initialize(server)
  702. if config.Datastore.MySQL.Enabled {
  703. server.historyDB.Initialize(server.logger, config.Datastore.MySQL)
  704. err = server.historyDB.Open()
  705. if err != nil {
  706. server.logger.Error("internal", "could not connect to mysql", err.Error())
  707. return err
  708. }
  709. }
  710. return nil
  711. }
  712. func (server *Server) setupListeners(config *Config) (err error) {
  713. logListener := func(addr string, config utils.ListenerConfig) {
  714. server.logger.Info("listeners",
  715. fmt.Sprintf("now listening on %s, tls=%t, proxy=%t, tor=%t, websocket=%t.", addr, (config.TLSConfig != nil), config.RequireProxy, config.Tor, config.WebSocket),
  716. )
  717. }
  718. // update or destroy all existing listeners
  719. for addr := range server.listeners {
  720. currentListener := server.listeners[addr]
  721. newConfig, stillConfigured := config.Server.trueListeners[addr]
  722. if stillConfigured {
  723. if reloadErr := currentListener.Reload(newConfig); reloadErr == nil {
  724. logListener(addr, newConfig)
  725. } else {
  726. // stop the listener; we will attempt to replace it below
  727. currentListener.Stop()
  728. delete(server.listeners, addr)
  729. }
  730. } else {
  731. currentListener.Stop()
  732. delete(server.listeners, addr)
  733. server.logger.Info("listeners", fmt.Sprintf("stopped listening on %s.", addr))
  734. }
  735. }
  736. publicPlaintextListener := ""
  737. // create new listeners that were not previously configured,
  738. // or that couldn't be reloaded above:
  739. for newAddr, newConfig := range config.Server.trueListeners {
  740. if strings.HasPrefix(newAddr, ":") && !newConfig.Tor && !newConfig.STSOnly && newConfig.TLSConfig == nil {
  741. publicPlaintextListener = newAddr
  742. }
  743. _, exists := server.listeners[newAddr]
  744. if !exists {
  745. // make a new listener
  746. newListener, newErr := NewListener(server, newAddr, newConfig, config.Server.UnixBindMode)
  747. if newErr == nil {
  748. server.listeners[newAddr] = newListener
  749. logListener(newAddr, newConfig)
  750. } else {
  751. server.logger.Error("server", "couldn't listen on", newAddr, newErr.Error())
  752. err = newErr
  753. }
  754. }
  755. }
  756. if publicPlaintextListener != "" {
  757. server.logger.Warning("listeners", fmt.Sprintf("Warning: your server is configured with public plaintext listener %s. Consider disabling it for improved security and privacy.", publicPlaintextListener))
  758. }
  759. return
  760. }
  761. // Gets the abstract sequence from which we're going to query history;
  762. // we may already know the channel we're querying, or we may have
  763. // to look it up via a string query. This function is responsible for
  764. // privilege checking.
  765. // XXX: call this with providedChannel==nil and query=="" to get a sequence
  766. // suitable for ListCorrespondents (i.e., this function is still used to
  767. // decide whether the ringbuf or mysql is authoritative about the client's
  768. // message history).
  769. func (server *Server) GetHistorySequence(providedChannel *Channel, client *Client, query string) (channel *Channel, sequence history.Sequence, err error) {
  770. config := server.Config()
  771. // 4 cases: {persistent, ephemeral} x {normal, conversation}
  772. // with ephemeral history, target is implicit in the choice of `hist`,
  773. // and correspondent is "" if we're retrieving a channel or *, and the correspondent's name
  774. // if we're retrieving a DM conversation ("query buffer"). with persistent history,
  775. // target is always nonempty, and correspondent is either empty or nonempty as before.
  776. var status HistoryStatus
  777. var target, correspondent string
  778. var hist *history.Buffer
  779. restriction := HistoryCutoffNone
  780. channel = providedChannel
  781. if channel == nil {
  782. if strings.HasPrefix(query, "#") {
  783. channel = server.channels.Get(query)
  784. if channel == nil {
  785. return
  786. }
  787. }
  788. }
  789. var joinTimeCutoff time.Time
  790. if channel != nil {
  791. if present, cutoff := channel.joinTimeCutoff(client); present {
  792. joinTimeCutoff = cutoff
  793. } else {
  794. err = errInsufficientPrivs
  795. return
  796. }
  797. status, target, restriction = channel.historyStatus(config)
  798. switch status {
  799. case HistoryEphemeral:
  800. hist = &channel.history
  801. case HistoryPersistent:
  802. // already set `target`
  803. default:
  804. return
  805. }
  806. } else {
  807. status, target = client.historyStatus(config)
  808. if query != "" {
  809. correspondent, err = CasefoldName(query)
  810. if err != nil {
  811. return
  812. }
  813. }
  814. switch status {
  815. case HistoryEphemeral:
  816. hist = &client.history
  817. case HistoryPersistent:
  818. // already set `target`, and `correspondent` if necessary
  819. default:
  820. return
  821. }
  822. }
  823. var cutoff time.Time
  824. if config.History.Restrictions.ExpireTime != 0 {
  825. cutoff = time.Now().UTC().Add(-time.Duration(config.History.Restrictions.ExpireTime))
  826. }
  827. // #836: registration date cutoff is always enforced for DMs
  828. // either way, take the later of the two cutoffs
  829. if restriction == HistoryCutoffRegistrationTime || channel == nil {
  830. regCutoff := client.historyCutoff()
  831. if regCutoff.After(cutoff) {
  832. cutoff = regCutoff
  833. }
  834. } else if restriction == HistoryCutoffJoinTime {
  835. if joinTimeCutoff.After(cutoff) {
  836. cutoff = joinTimeCutoff
  837. }
  838. }
  839. // #836 again: grace period is never applied to DMs
  840. if !cutoff.IsZero() && channel != nil && restriction != HistoryCutoffJoinTime {
  841. cutoff = cutoff.Add(-time.Duration(config.History.Restrictions.GracePeriod))
  842. }
  843. if hist != nil {
  844. sequence = hist.MakeSequence(correspondent, cutoff)
  845. } else if target != "" {
  846. sequence = server.historyDB.MakeSequence(target, correspondent, cutoff)
  847. }
  848. return
  849. }
  850. func (server *Server) ForgetHistory(accountName string) {
  851. // sanity check
  852. if accountName == "*" {
  853. return
  854. }
  855. config := server.Config()
  856. if !config.History.Enabled {
  857. return
  858. }
  859. if cfAccount, err := CasefoldName(accountName); err == nil {
  860. server.historyDB.Forget(cfAccount)
  861. }
  862. persistent := config.History.Persistent
  863. if persistent.Enabled && persistent.UnregisteredChannels && persistent.RegisteredChannels == PersistentMandatory && persistent.DirectMessages == PersistentMandatory {
  864. return
  865. }
  866. predicate := func(item *history.Item) bool { return item.AccountName == accountName }
  867. for _, channel := range server.channels.Channels() {
  868. channel.history.Delete(predicate)
  869. }
  870. for _, client := range server.clients.AllClients() {
  871. client.history.Delete(predicate)
  872. }
  873. }
  874. // deletes a message. target is a hint about what buffer it's in (not required for
  875. // persistent history, where all the msgids are indexed together). if accountName
  876. // is anything other than "*", it must match the recorded AccountName of the message
  877. func (server *Server) DeleteMessage(target, msgid, accountName string) (err error) {
  878. config := server.Config()
  879. var hist *history.Buffer
  880. if target != "" {
  881. if target[0] == '#' {
  882. channel := server.channels.Get(target)
  883. if channel != nil {
  884. if status, _, _ := channel.historyStatus(config); status == HistoryEphemeral {
  885. hist = &channel.history
  886. }
  887. }
  888. } else {
  889. client := server.clients.Get(target)
  890. if client != nil {
  891. if status, _ := client.historyStatus(config); status == HistoryEphemeral {
  892. hist = &client.history
  893. }
  894. }
  895. }
  896. }
  897. if hist == nil {
  898. err = server.historyDB.DeleteMsgid(msgid, accountName)
  899. } else {
  900. count := hist.Delete(func(item *history.Item) bool {
  901. return item.Message.Msgid == msgid && (accountName == "*" || item.AccountName == accountName)
  902. })
  903. if count == 0 {
  904. err = errNoop
  905. }
  906. }
  907. return
  908. }
  909. func (server *Server) UnfoldName(cfname string) (name string) {
  910. if strings.HasPrefix(cfname, "#") {
  911. return server.channels.UnfoldName(cfname)
  912. }
  913. return server.clients.UnfoldNick(cfname)
  914. }
  915. // elistMatcher takes and matches ELIST conditions
  916. type elistMatcher struct {
  917. MinClientsActive bool
  918. MinClients int
  919. MaxClientsActive bool
  920. MaxClients int
  921. }
  922. // Matches checks whether the given channel matches our matches.
  923. func (matcher *elistMatcher) Matches(channel *Channel) bool {
  924. if matcher.MinClientsActive {
  925. if len(channel.Members()) < matcher.MinClients {
  926. return false
  927. }
  928. }
  929. if matcher.MaxClientsActive {
  930. if len(channel.Members()) < len(channel.members) {
  931. return false
  932. }
  933. }
  934. return true
  935. }
  936. var (
  937. infoString1 = strings.Split(`
  938. __ __ ______ ___ ______ ___
  939. __/ // /_/ ____/ __ \/ ____/ __ \
  940. /_ // __/ __/ / /_/ / / __/ / / /
  941. /_ // __/ /___/ _, _/ /_/ / /_/ /
  942. /_//_/ /_____/_/ |_|\____/\____/
  943. https://ergo.chat/
  944. https://github.com/ergochat/ergo
  945. `, "\n")[1:] // XXX: cut off initial blank line
  946. infoString2 = strings.Split(` Daniel Oakley, DanielOaks, <daniel@danieloaks.net>
  947. Shivaram Lingamneni, slingamn, <slingamn@cs.stanford.edu>
  948. `, "\n")
  949. infoString3 = strings.Split(` Jeremy Latt, jlatt
  950. Edmund Huber, edmund-huber
  951. `, "\n")
  952. )