diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/darkplaces-rcon.cabal b/darkplaces-rcon.cabal new file mode 100644 --- /dev/null +++ b/darkplaces-rcon.cabal @@ -0,0 +1,62 @@ +name: darkplaces-rcon +version: 0.1 +license: GPL-2 +license-file: LICENSE +author: Slava Bacherikov +maintainer: slava@bacher09.org +homepage: https://github.com/bacher09/darkplaces-rcon +bug-reports: https://github.com/bacher09/darkplaces-rcon/issues +copyright: (c) Slava Bacherikov 2015 +category: Game +build-type: Simple +cabal-version: >=1.10 +synopsis: Darkplaces rcon client library +description: + + Rcon client library for Darkplaces game engine. It fully + implemnts both non-secure and "secure" rcon protocols. + Supports such games as Xonotic, Nexuiz. + +flag IntegrationTest + default: False + description: Enable Integration testing + +library + exposed-modules: DarkPlaces.Rcon, + DarkPlaces.Rcon.Internal + hs-source-dirs: src + build-depends: base >=4.5 && <5, + bytestring >=0.10 && <0.11, + cryptohash >= 0.11 && <0.12, + network >= 2.6, + time >= 1.3, + byteable + + ghc-options: -O2 -funbox-strict-fields -Wall -fno-warn-name-shadowing + ghc-prof-options: -prof -auto-all -rtsopts -fprof-auto -caf-all + default-language: Haskell2010 + +test-suite rcon-tests + default-language: Haskell2010 + type: exitcode-stdio-1.0 + hs-source-dirs: tests + main-is: Spec.hs + other-modules: DarkPlaces.RconSpec, + DarkPlaces.Rcon.InternalSpec + + build-depends: base >=4.7 && <4.8, + bytestring >=0.10 && <0.11, + darkplaces-rcon, + hspec-core, + hspec + + default-extensions: OverloadedStrings + ghc-options: -O2 -funbox-strict-fields -Wall -fno-warn-name-shadowing + + if flag(IntegrationTest) + cpp-options: -DINTEGRATION + + +source-repository head + type: git + location: https://github.com/bacher09/darkplaces-rcon.git diff --git a/src/DarkPlaces/Rcon.hs b/src/DarkPlaces/Rcon.hs new file mode 100644 --- /dev/null +++ b/src/DarkPlaces/Rcon.hs @@ -0,0 +1,231 @@ +module DarkPlaces.Rcon ( + RconMode(..), + ProtocolOptions(..), + RconInfo(..), + RconConnection, + defaultRcon, + makeRcon, + connect, + close, + isConnected, + send, + recv, + recvRcon, + enableLog, + disableLog, + setPassword, + setMode, + setTimeDiff, + getPassword, + getMode, + getTimeDiff, + getHost, + getPort +) where +import DarkPlaces.Rcon.Internal +import qualified Data.ByteString as B +import qualified Data.ByteString.Char8 as BC +import Network.Socket hiding (connect, close, isConnected, send, recv) +import qualified Network.Socket as N +import qualified Network.Socket.ByteString as NB +import qualified Network.Socket.ByteString.Lazy as NBL +import Data.IORef +import Data.Time.Clock.POSIX (getPOSIXTime) +import Control.Monad +import Control.Applicative + + +data RconMode = NonSecureRcon + | TimeSecureRcon + | ChallangeSecureRcon + deriving(Show, Read, Eq, Ord, Enum, Bounded) + + +data ProtocolOptions = OnlyIPv4 + | OnlyIPv6 + | BothProtocols + deriving(Show, Read, Eq, Ord, Enum, Bounded) + + +data RconInfo = RconInfo { + rconHost :: HostName, + rconPort :: ServiceName, + rconMode :: RconMode, + rconPassword :: B.ByteString, + rconTimeDiff :: Int, + rconProtoOpt :: ProtocolOptions +} deriving (Show, Read, Eq) + + +data RconConnection = RconConnection { + connSocket :: Socket, + connInfo :: IORef RconInfo, + getChallange :: IO B.ByteString +} + + +defaultRcon :: RconInfo +defaultRcon = RconInfo {rconHost="localhost", + rconPort="26000", + rconMode=TimeSecureRcon, + rconPassword=B.empty, + rconTimeDiff=0, + rconProtoOpt=BothProtocols} + + +sockGetChallenge :: Socket -> IO B.ByteString +sockGetChallenge s = NB.send s challangePacket >> recvChallange + where + getResponse = NB.recv s maxPacketSize + recvChallange = do + resp <- getResponse + case parseChallenge resp of + Just challenge -> return challenge + Nothing -> recvChallange + + +createDPSocket :: HostName -> ServiceName -> ProtocolOptions -> IO Socket +createDPSocket host port opt = do + host_addr <- getHostAddr + sock <- socket (addrFamily host_addr) Datagram (addrProtocol host_addr) + N.connect sock (addrAddress host_addr) + return sock + where + getHostAddr = head `fmap` getAddrInfo (Just hints) (Just host) (Just port) + dg_hints = defaultHints {addrSocketType=Datagram, addrFlags=[AI_ADDRCONFIG]} + hints = case opt of + BothProtocols -> dg_hints + OnlyIPv4 -> dg_hints {addrFamily=AF_INET} + OnlyIPv6 -> dg_hints {addrFamily=AF_INET6} + +-- | Create `RconInfo` for givven host, port and password +makeRcon :: HostName -> ServiceName -> B.ByteString -> RconInfo +makeRcon host port passw = defaultRcon {rconHost=host, + rconPort=port, + rconPassword=passw} + + +-- | Connect to darkplaces server +connect :: RconInfo -> IO RconConnection +connect rcon = do + sock <- createDPSocket host port opt + info_ref <- newIORef rcon + return RconConnection {connSocket=sock, + connInfo=info_ref, + getChallange=sockGetChallenge sock} + where + host = rconHost rcon + port = rconPort rcon + opt = rconProtoOpt rcon + + +-- | Close connection +close :: RconConnection -> IO () +close = N.close . connSocket + +-- | Return True if connection is active +-- and False if it closed +isConnected :: RconConnection -> IO Bool +isConnected = N.isConnected . connSocket + +-- | Sends rcon command via `RconConnection` +send :: RconConnection -> B.ByteString -> IO () +send conn command = void $ NBL.send (connSocket conn) =<< rconPacket + where + rconNonsec rcon = rconNonSecurePacket (rconPassword rcon) command + rconSecTime rcon = do + cur_time <- getPOSIXTime + let send_time = realToFrac cur_time + fromIntegral (rconTimeDiff rcon) :: Double + return $ rconSecureTimePacket send_time (rconPassword rcon) command + rconSecChallange rcon = do + challange <- getChallange conn + return $ rconSecureChallangePacket challange (rconPassword rcon) command + rconPacket = do + rcon <- readIORef $ connInfo conn + case rconMode rcon of + NonSecureRcon -> return $ rconNonsec rcon + TimeSecureRcon -> rconSecTime rcon + ChallangeSecureRcon -> rconSecChallange rcon + +-- | Receive packet and tries parse it as rcon packet. +-- If succeeds returns Right ByteString with parsed response +-- else returns Left ByteString with raw packet +recv :: RconConnection -> IO (Either B.ByteString B.ByteString) +recv conn = do + resp <- NB.recv sock maxPacketSize + return $ maybe (Left resp) Right $ parseRcon resp + where + sock = connSocket conn + +-- | Waits for rcon packet and return parsed response. +-- if parsing fails it discard packet and waits another. +recvRcon :: RconConnection -> IO B.ByteString +recvRcon conn = do + e_resp <- recv conn + either (const $ recvRcon conn) return e_resp + + +socketStr :: RconConnection -> IO B.ByteString +socketStr c = BC.pack . show <$> getSocketName (connSocket c) + + +enableLogStr :: RconConnection -> IO B.ByteString +enableLogStr rc = BC.append log_begin <$> socketStr rc + where + log_begin = BC.pack "sv_cmd addtolist log_dest_udp " + + +disableLogStr :: RconConnection -> IO B.ByteString +disableLogStr rc = BC.append log_begin <$> socketStr rc + where + log_begin = BC.pack "sv_cmd removefromlist log_dest_udp " + + +-- | Send rcon command for activating rcon log. +-- This feature will not work over NAT +enableLog :: RconConnection -> IO () +enableLog c = send c =<< enableLogStr c + +-- | Opposite action for `enableLog` +disableLog :: RconConnection -> IO () +disableLog c = send c =<< disableLogStr c + + +setParam :: RconConnection -> (RconInfo -> RconInfo) -> IO () +setParam c f = atomicModifyIORef (connInfo c) $ \r -> (f r, ()) + + +getParam :: RconConnection -> (RconInfo -> a) -> IO a +getParam c fun = fun `fmap` readIORef (connInfo c) + + +setPassword :: RconConnection -> B.ByteString -> IO () +setPassword c passw = setParam c $ \rcon -> rcon {rconPassword=passw} + + +setMode :: RconConnection -> RconMode -> IO () +setMode c mode = setParam c $ \rcon -> rcon {rconMode=mode} + + +setTimeDiff :: RconConnection -> Int -> IO () +setTimeDiff c time = setParam c $ \rcon -> rcon {rconTimeDiff=time} + + +getPassword :: RconConnection -> IO B.ByteString +getPassword c = getParam c rconPassword + + +getMode :: RconConnection -> IO RconMode +getMode c = getParam c rconMode + + +getTimeDiff :: RconConnection -> IO Int +getTimeDiff c = getParam c rconTimeDiff + + +getHost :: RconConnection -> IO HostName +getHost c = getParam c rconHost + + +getPort :: RconConnection -> IO ServiceName +getPort c = getParam c rconPort diff --git a/src/DarkPlaces/Rcon/Internal.hs b/src/DarkPlaces/Rcon/Internal.hs new file mode 100644 --- /dev/null +++ b/src/DarkPlaces/Rcon/Internal.hs @@ -0,0 +1,98 @@ +module DarkPlaces.Rcon.Internal where +import Crypto.Hash +import Data.Byteable +import qualified Data.ByteString as B +import qualified Data.ByteString.Char8 as BC +import qualified Data.ByteString.Builder as BB +import qualified Data.ByteString.Lazy as BL +import Data.Monoid +import Text.Printf + +-- | max Darkplaces packet size +maxPacketSize :: Int +maxPacketSize = 1399 + + +quakePacketHeader :: B.ByteString +quakePacketHeader = B.pack [0xFF, 0xFF, 0xFF, 0xFF] + + +challangePacket :: B.ByteString +challangePacket = B.append quakePacketHeader $ BC.pack "getchallenge" + + +hmacMD4 :: B.ByteString -> B.ByteString -> B.ByteString +hmacMD4 secret msg = toBytes (hmac secret msg :: HMAC MD4) + + +parseChallenge :: B.ByteString -> Maybe B.ByteString +parseChallenge packet = if header `B.isPrefixOf` packet + then Just challenge + else Nothing + where + header = B.append quakePacketHeader $ BC.pack "challenge " + headerLen = B.length header + challenge = B.take 11 $ B.drop headerLen packet + +-- | Try to parse packet as dp rcon packet. +-- if parsing fails returns Nothing +parseRcon :: B.ByteString -> Maybe B.ByteString +parseRcon packet = if header `B.isPrefixOf` packet + then Just response + else Nothing + where + header = B.append quakePacketHeader $ BC.pack "n" + headerLen = B.length header + response = B.drop headerLen packet + + +-- | generates simple quake rcon packet +rconNonSecurePacket :: B.ByteString + -- ^ password + -> B.ByteString + -- ^ command + -> BL.ByteString +rconNonSecurePacket passw command = BB.toLazyByteString builder + where + builder = mconcat [BB.byteString quakePacketHeader, + BB.string7 "rcon ", + BB.byteString passw, + BB.char7 ' ', + BB.byteString command] + + +-- | generates time based secure packet +rconSecureTimePacket :: (Real a) => a + -- ^ Current unix timestamp + -> B.ByteString + -- ^ password + -> B.ByteString + -- ^ comand + -> BL.ByteString +rconSecureTimePacket t passw command = BB.toLazyByteString builder + where + time_str = BB.string7 $ printf "%.6f" (realToFrac t :: Double) + time_command = mconcat [time_str, BB.char7 ' ', BB.byteString command] + time_command_str = BL.toStrict $ BB.toLazyByteString time_command + key = BB.byteString $ hmacMD4 passw time_command_str + builder = mconcat [BB.byteString quakePacketHeader, + BB.string7 "srcon HMAC-MD4 TIME ", + key, BB.char7 ' ', + BB.byteString time_command_str] + +-- | generates chalange based secure packet +rconSecureChallangePacket :: B.ByteString + -- ^ connection's challange + -> B.ByteString + -- ^ password + -> B.ByteString + -- ^ command + -> BL.ByteString +rconSecureChallangePacket challenge passw command = BB.toLazyByteString builder + where + hmac_key = BL.toStrict $ BL.fromChunks [challenge, BC.pack " ", command] + key = BB.byteString $ hmacMD4 passw hmac_key + builder = mconcat [BB.byteString quakePacketHeader, + BB.string7 "srcon HMAC-MD4 CHALLENGE ", + key, BB.char7 ' ', BB.byteString challenge, + BB.char7 ' ', BB.byteString command] diff --git a/tests/DarkPlaces/Rcon/InternalSpec.hs b/tests/DarkPlaces/Rcon/InternalSpec.hs new file mode 100644 --- /dev/null +++ b/tests/DarkPlaces/Rcon/InternalSpec.hs @@ -0,0 +1,39 @@ +module DarkPlaces.Rcon.InternalSpec ( + spec +) where +import Test.Hspec +import DarkPlaces.Rcon.Internal + + +spec :: Spec +spec = do + describe "rconNonSecurePacket" $ do + it "when password is passw and command status" $ do + let res = "\xFF\xFF\xFF\xFFrcon passw status" + rconNonSecurePacket "passw" "status" `shouldBe` res + + describe "rconSecureTimePacket" $ do + it "when time is 100.0, password is passw and command status" $ do + let res = "\xff\xff\xff\xffsrcon HMAC-MD4 TIME \ + \R\xcbv\xf0\xa7p\xcd\xca\xf2!\xc3~\x06\ + \\xa9\x9f\xa8 100.000000 status" + + rconSecureTimePacket (100.0 :: Float) "passw" "status" `shouldBe` res + + describe "rconSecureChallangePacket" $ do + it "when challange is 11111111111 password is passw and command status" $ do + let res = "\xff\xff\xff\xffsrcon HMAC-MD4 CHALLENGE \ + \D\x89\xfd\x15\xccZ\xea\xeb\x0e\xbfl\xd6\&C\ + \\x05T\x12 11111111111 status" + rconSecureChallangePacket "11111111111" "passw" "status" `shouldBe` res + + describe "parseChallenge" $ do + it "valid packet return challange" $ do + let resp = "\xff\xff\xff\xff\&challenge 11111111111\x00vlen.\ + \\x00\x00\x00d0pkXon//KssdlzGkFKdnnN4sgg8H+koTb\ + \Bn5JTi37BAW1t=\x00\x00" + + parseChallenge resp `shouldBe` Just "11111111111" + + it "invalid packet should return nothing" $ do + parseChallenge "bad packet" `shouldBe` Nothing diff --git a/tests/DarkPlaces/RconSpec.hs b/tests/DarkPlaces/RconSpec.hs new file mode 100644 --- /dev/null +++ b/tests/DarkPlaces/RconSpec.hs @@ -0,0 +1,34 @@ +{-# LANGUAGE CPP #-} +module DarkPlaces.RconSpec ( + spec +) where +import Test.Hspec +#ifdef INTEGRATION +import DarkPlaces.Rcon +import qualified Data.ByteString as B +#else +import qualified Test.Hspec.Core.Spec as HC +#endif + + +spec :: Spec +#ifdef INTEGRATION +spec = do + describe "connect" $ do + let rcon = makeRcon "localhost" "26000" "test" + it "should answer to status command" $ do + c <- connect rcon + checkResponse c NonSecureRcon + checkResponse c TimeSecureRcon + checkResponse c ChallangeSecureRcon + isConnected c `shouldReturn` True + close c + where + checkResponse c mode = do + setMode c mode + send c "status" + r <- recvRcon c + r `shouldSatisfy` B.isPrefixOf "host:" +#else +spec = HC.fromSpecList [] +#endif diff --git a/tests/Spec.hs b/tests/Spec.hs new file mode 100644 --- /dev/null +++ b/tests/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}