├── DNP3_Lib └── DNP3_Lib.py ├── License ├── README.md └── crcmod ├── __init__.py ├── __init__.pyc ├── _crcfunpy.py ├── _crcfunpy.pyc ├── crcmod.py ├── crcmod.pyc ├── predefined.py ├── predefined.pyc └── test.py /DNP3_Lib/DNP3_Lib.py: -------------------------------------------------------------------------------- 1 | __author__ = 'Nicholas Rodofile' 2 | from scapy.all import * 3 | import crcmod.predefined 4 | 5 | ''' 6 | # Copyright 2014-2016 N.R Rodofile 7 | 8 | Licensed under the GPLv3. 9 | This program is free software: you can redistribute it and/or modify it under the terms 10 | of the GNU General Public License as published by the Free Software Foundation, either 11 | version 3 of the License, or (at your option) any later version. 12 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 14 | without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 15 | See the GNU General Public License for more details. You should have received a copy of 16 | the GNU General Public License along with this program. If not, see 17 | http://www.gnu.org/licenses/. 18 | ''' 19 | 20 | bitState = {1: "SET", 0: "UNSET"} 21 | stations = {1: "MASTER", 0: "OUTSTATION"} 22 | 23 | MASTER = 1 24 | OUTSTATION = 0 25 | SET = 1 26 | UNSET = 0 27 | dnp3_port = 20000 28 | 29 | Transport_summary = "Seq:%DNP3Transport.SEQUENCE% " 30 | Application_Rsp_summary = "Response %DNP3ApplicationResponse.FUNC_CODE% " 31 | Application_Req_summary = "Request %DNP3ApplicationRequest.FUNC_CODE% " 32 | DNP3_summary = "From %DNP3.SOURCE% to %DNP3.DESTINATION% " 33 | 34 | ''' 35 | Initalise a predefined crc object for DNP3 Cyclic Redundancy Check 36 | Info : http://crcmod.sourceforge.net/crcmod.predefined.html 37 | ''' 38 | def crcDNP(data): 39 | crc16DNP = crcmod.predefined.mkCrcFun('crc-16-dnp') 40 | return crc16DNP(data) 41 | 42 | 43 | def CRC_check(chunk, crc): 44 | chunk_crc = crcDNP(chunk) 45 | crc = struct.unpack(' 18: 60 | chunk = payload[:18] 61 | chunk = update_data_chunk_crc(chunk) 62 | payload = chunk + payload[18:] 63 | 64 | else: 65 | chunk = payload[:-2] 66 | chunk = update_data_chunk_crc(chunk) 67 | payload = chunk 68 | return payload 69 | 70 | 71 | applicationFunctionCode = { 72 | 0: "CONFIRM", 73 | 1: "READ", 74 | 2: "WRITE", 75 | 3: "SELECT", 76 | 4: "OPERATE", 77 | 5: "DIRECT_OPERATE", 78 | 6: "DIRECT_OPERATE_NR", 79 | 7: "IMMED_FREEZE", 80 | 8: "IMMED_FREEZE_NR", 81 | 9: "FREEZE_CLEAR", 82 | 10: "FREEZE_CLEAR_NR", 83 | 11: "FREEZE_AT_TIME", 84 | 12: "FREEZE_AT_TIME_NR", 85 | 13: "COLD_RESTART", 86 | 14: "WARM_RESTART", 87 | 15: "INITIALIZE_DATA", 88 | 16: "INITIALIZE_APPL", 89 | 17: "START_APPL", 90 | 18: "STOP_APPL", 91 | 19: "SAVE_CONFIG", 92 | 20: "ENABLE_UNSOLICITED", 93 | 21: "DISABLE_UNSOLICITED", 94 | 22: "ASSIGN_CLASS", 95 | 23: "DELAY_MEASURE", 96 | 24: "RECORD_CURRENT_TIME", 97 | 25: "OPEN_FILE", 98 | 26: "CLOSE_FILE", 99 | 27: "DELETE_FILE", 100 | 28: "GET_FILE_INFO", 101 | 29: "AUTHENTICATE_FILE", 102 | 30: "ABORT_FILE", 103 | 31: "ACTIVATE_CONFIG", 104 | 32: "AUTHENTICATE_REQ", 105 | 33: "AUTH_REQ_NO_ACK", 106 | 129: "RESPONSE", 107 | 130: "UNSOLICITED_RESPONSE", 108 | 131: "AUTHENTICATE_RESP", 109 | } 110 | 111 | 112 | class DNP3RequestDataObjects(Packet): 113 | fields_desc = [ 114 | BitField("Obj", 1, 4), 115 | BitField("Var", 1, 4), 116 | BitField("IndexPref", 1, 4), 117 | BitEnumField("QualfierCode", 1, 4, bitState), 118 | ] 119 | 120 | def extract_padding(self, p): 121 | return "", p 122 | 123 | class DNP3Application(Packet): 124 | def guess_payload_class(self, payload): 125 | return Packet.guess_payload_class(self, payload) 126 | 127 | 128 | class DNP3ApplicationControl(Packet): 129 | fields_desc = [ 130 | BitEnumField("FIN", 1, 1, bitState), 131 | BitEnumField("FIR", 1, 1, bitState), 132 | BitEnumField("CON", 1, 1, bitState), 133 | BitEnumField("UNS", 1, 1, bitState), 134 | BitField("SEQ", 1, 4), 135 | ] 136 | 137 | def extract_padding(self, p): 138 | return "", p 139 | 140 | 141 | class DNP3ApplicationIIN(Packet): 142 | name = "DNP3_Application_response" 143 | fields_desc = [ 144 | BitEnumField("DEVICE_RESTART", UNSET, 1, bitState), 145 | BitEnumField("DEVICE_TROUBLE", UNSET, 1, bitState), 146 | BitEnumField("LOCAL_CONTROL", UNSET, 1, bitState), 147 | BitEnumField("NEED_TIME", UNSET, 1, bitState), 148 | BitEnumField("CLASS_3_EVENTS", UNSET, 1, bitState), 149 | BitEnumField("CLASS_2_EVENTS", UNSET, 1, bitState), 150 | BitEnumField("CLASS_1_EVENTS", UNSET, 1, bitState), 151 | BitEnumField("BROADCAST", UNSET, 1, bitState), 152 | BitEnumField("RESERVED_1", UNSET, 1, bitState), 153 | BitEnumField("RESERVED_2", UNSET, 1, bitState), 154 | BitEnumField("CONFIG_CORRUPT", UNSET, 1, bitState), 155 | BitEnumField("ALREADY_EXECUTING", UNSET, 1, bitState), 156 | BitEnumField("EVENT_BUFFER_OVERFLOW", UNSET, 1, bitState), 157 | BitEnumField("PARAMETER_ERROR", UNSET, 1, bitState), 158 | BitEnumField("OBJECT_UNKNOWN", UNSET, 1, bitState), 159 | BitEnumField("NO_FUNC_CODE_SUPPORT", UNSET, 1, bitState), 160 | ] 161 | 162 | def extract_padding(self, p): 163 | return "", p 164 | 165 | class DNP3ApplicationResponse(DNP3Application): 166 | name = "DNP3_Application_response" 167 | fields_desc = [ 168 | PacketField("Application_control", DNP3ApplicationControl(), DNP3ApplicationControl), 169 | BitEnumField("FUNC_CODE", 1, 8, applicationFunctionCode), 170 | PacketField("IIN", DNP3ApplicationIIN(), DNP3ApplicationIIN), 171 | ] 172 | 173 | def mysummary(self): 174 | if isinstance(self.underlayer.underlayer, DNP3): 175 | print self.FUNC_CODE.SEQ, "Hello" 176 | return self.underlayer.underlayer.sprintf(DNP3_summary + Transport_summary + Application_Rsp_summary) 177 | if isinstance(self.underlayer, DNP3Transport): 178 | return self.underlayer.sprintf(Transport_summary + Application_Rsp_summary) 179 | else: 180 | return self.sprintf(Application_Req_summary) 181 | 182 | class DNP3ApplicationRequest(DNP3Application): 183 | name = "DNP3_Application_request" 184 | fields_desc = [ 185 | PacketField("Application_control", DNP3ApplicationControl(), DNP3ApplicationControl), 186 | BitEnumField("FUNC_CODE", 1, 8, applicationFunctionCode), 187 | ] 188 | 189 | def mysummary(self): 190 | if isinstance(self.underlayer.underlayer, DNP3): 191 | return self.underlayer.underlayer.sprintf(DNP3_summary + Transport_summary + Application_Req_summary) 192 | if isinstance(self.underlayer, DNP3Transport): 193 | return self.underlayer.sprintf(Transport_summary + Application_Req_summary) 194 | else: 195 | return self.sprintf(Application_Req_summary) 196 | 197 | 198 | class DNP3Transport(Packet): 199 | name = "DNP3_Transport" 200 | fields_desc = [ 201 | BitEnumField("FIN", None, 1, bitState), 202 | BitEnumField("FIR", None, 1, bitState), 203 | BitField("SEQUENCE", None, 6), 204 | ] 205 | 206 | def guess_payload_class(self, payload): 207 | 208 | if isinstance(self.underlayer, DNP3): 209 | DIR = self.underlayer.CONTROL.DIR 210 | 211 | if DIR == MASTER: 212 | return DNP3ApplicationRequest 213 | 214 | if DIR == OUTSTATION: 215 | return DNP3ApplicationResponse 216 | else: 217 | return Packet.guess_payload_class(self, payload) 218 | 219 | 220 | class DNP3HeaderControl(Packet): 221 | name = "DNP3_Header_control" 222 | 223 | controlFunctionCodePri = { 224 | 0: "RESET_LINK_STATES", 225 | 2: "TEST_LINK_STATES", 226 | 3: "CONFIRMED_USER_DATA", 227 | 4: "UNCONFIRMED_USER_DATA", 228 | 9: "REQUEST_LINK_STATUS", 229 | } 230 | 231 | controlFunctionCodeSec = { 232 | 0: "ACK", 233 | 1: "NACK", 234 | 11: "LINK_STATUS", 235 | 15: "NOT_SUPPORTED", 236 | } 237 | 238 | cond_field = [ 239 | BitEnumField("FCB", 0, 1, bitState), 240 | BitEnumField("FCV", 0, 1, bitState), 241 | BitEnumField("FUNC_CODE_PRI", 4, 4, controlFunctionCodePri), 242 | BitEnumField("reserved", 0, 1, bitState), 243 | BitEnumField("DFC", 0, 1, bitState), 244 | BitEnumField("FUNC_CODE_SEC", 4, 4, controlFunctionCodeSec), 245 | ] 246 | 247 | fields_desc = [ 248 | BitEnumField("DIR", MASTER, 1, stations), # 9.2.4.1.3.1 DIR bit field 249 | BitEnumField("PRM", MASTER, 1, stations), # 9.2.4.1.3.2 PRM bit field 250 | ConditionalField(cond_field[0], lambda x:x.PRM == MASTER), 251 | ConditionalField(cond_field[1], lambda x:x.PRM == MASTER), 252 | ConditionalField(cond_field[2], lambda x:x.PRM == MASTER), 253 | ConditionalField(cond_field[3], lambda x:x.PRM == OUTSTATION), 254 | ConditionalField(cond_field[4], lambda x:x.PRM == OUTSTATION), 255 | ConditionalField(cond_field[5], lambda x:x.PRM == OUTSTATION), 256 | ] 257 | 258 | def extract_padding(self, p): 259 | return "", p 260 | 261 | 262 | class DNP3(Packet): 263 | name = "DNP3" 264 | fields_desc = [ 265 | XShortField("START", 0x0564), 266 | ByteField("LENGTH", None), 267 | PacketField("CONTROL", None, DNP3HeaderControl), 268 | LEShortField("DESTINATION", None), 269 | LEShortField("SOURCE", None), 270 | XShortField("CRC", None), 271 | ] 272 | 273 | data_chunks = [] # Data Chunks are 16 octets 274 | data_chunks_crc = [] 275 | chunk_len = 18 276 | data_chunk_len = 16 277 | 278 | def show_data_chunks(self): 279 | for i in range(len(self.data_chunks)): 280 | print "\tData Chunk", i, "Len", len(self.data_chunks[i]),\ 281 | "CRC (", hex(struct.unpack(' 0: 299 | chunks += 1 300 | 301 | if pay_len == 3 and self.CONTROL.DIR == MASTER: 302 | 303 | # No IIN in Application layer and empty Payload 304 | pay = pay + struct.pack('H', crcDNP(pay)) 305 | 306 | if pay_len == 5 and self.CONTROL.DIR == OUTSTATION: 307 | 308 | # IIN in Application layer and empty Payload 309 | pay = pay + struct.pack('H', crcDNP(pay)) 310 | 311 | if self.LENGTH is None: 312 | 313 | # Remove length , crc, start octets as part of length 314 | length = (len(pkt+pay) - ((chunks * 2) + 1 + 2 + 2)) 315 | pkt = pkt[:2] + struct.pack(' 0): 334 | self.add_data_chunk(pay[index:]) 335 | break # should be the last chunk 336 | else: 337 | self.add_data_chunk(pay[index:index + cnk_len]) 338 | remaining_pay -= cnk_len 339 | 340 | payload = '' 341 | for chunk in range(len(self.data_chunks)): 342 | payload = payload + self.data_chunks[chunk] + self.data_chunks_crc[chunk] 343 | # self.show_data_chunks() # --DEBUGGING 344 | return pkt+payload 345 | 346 | def guess_payload_class(self, payload): 347 | if len(payload) > 0: 348 | return DNP3Transport 349 | else: 350 | return Packet.guess_payload_class(self, payload) 351 | 352 | 353 | bind_layers(TCP, DNP3, dport=dnp3_port) 354 | bind_layers(TCP, DNP3, sport=dnp3_port) 355 | bind_layers(UDP, DNP3, dport=dnp3_port) 356 | bind_layers(UDP, DNP3, sport=dnp3_port) 357 | 358 | -------------------------------------------------------------------------------- /License: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | #DNP3 Dissector for Scapy 2 | 3 | The Distributed Network Protocol (DNP3) is defined in [IEEE Std 1815](https://standards.ieee.org/findstds/standard/1815-2012.html) for the purpose of distributing event data for operation on a variety of communication media consistent with the makeup of most electric power communication systems. 4 | 5 | This project is work-in-progress by the Queensland University of Technology(QUT) [Information Security discipline](https://www.qut.edu.au/science-engineering/our-schools/school-of-electrical-engineering-and-computer-science/information-security) and was developed to study cyber attacks on DNP3 critical infrustrcutre. The work can be demonstrated in our paper, [Real-Time and Interactive Attacks on DNP3 Critical Infrastructure Using Scapy](http://crpit.com/confpapers/CRPITV161Rodofile.pdf), published in the CRPIT and Presented at the Australasian Information Security Conference (AISC 2015) in Sydney Australia. 6 | 7 | This code is also used in the following papers: 8 | 9 | Rodofile, Nicholas R., Kenneth Radke, and Ernest Foo. "[DNP3 network scanning and reconnaissance for critical infrastructure.](http://eprints.qut.edu.au/93117/)" Proceedings of the Australasian Computer Science Week Multiconference. ACM, 2016. 10 | 11 | Rodofile, Nicholas R., Kenneth Radke, and Ernest Foo. "[Framework for SCADA cyber-attack dataset creation.](http://dl.acm.org/citation.cfm?id=3014883)" Proceedings of the Australasian Computer Science Week Multiconference. ACM, 2017. 12 | 13 | If you use this code in any academic work, it would be very much appreciated if you cite our papers. 14 | 15 | Please note that this code requires the [scapy](http://www.secdev.org/projects/scapy/doc/index.html) library. 16 | 17 | For more [QUT Information Security projects](http://qut-infosec.github.io/), visit our Github Repository. 18 | 19 | ##License 20 | Copyright 2014-2016 N.R Rodofile 21 | 22 | Licensed under the GPLv3. 23 | 24 | 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 3 of the License, or (at your option) any later version. 25 | 26 | 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. 27 | 28 | You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. 29 | -------------------------------------------------------------------------------- /crcmod/__init__.py: -------------------------------------------------------------------------------- 1 | try: 2 | from crcmod.crcmod import * 3 | import crcmod.predefined 4 | except ImportError: 5 | # Make this backward compatible 6 | from crcmod import * 7 | import predefined 8 | __doc__ = crcmod.__doc__ 9 | -------------------------------------------------------------------------------- /crcmod/__init__.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nrodofile/ScapyDNP3_lib/70902fce1a1feb5c6be77ec3503620e54f41887a/crcmod/__init__.pyc -------------------------------------------------------------------------------- /crcmod/_crcfunpy.py: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------------- 2 | # Low level CRC functions for use by crcmod. This version is implemented in 3 | # Python for a couple of reasons. 1) Provide a reference implememtation. 4 | # 2) Provide a version that can be used on systems where a C compiler is not 5 | # available for building extension modules. 6 | # 7 | # Copyright (c) 2004 Raymond L. Buvel 8 | # 9 | # Permission is hereby granted, free of charge, to any person obtaining a copy 10 | # of this software and associated documentation files (the "Software"), to deal 11 | # in the Software without restriction, including without limitation the rights 12 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 13 | # copies of the Software, and to permit persons to whom the Software is 14 | # furnished to do so, subject to the following conditions: 15 | # 16 | # The above copyright notice and this permission notice shall be included in 17 | # all copies or substantial portions of the Software. 18 | # 19 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 22 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 25 | # SOFTWARE. 26 | #----------------------------------------------------------------------------- 27 | 28 | def _crc8(data, crc, table): 29 | crc = crc & 0xFF 30 | for x in data: 31 | crc = table[ord(x) ^ crc] 32 | return crc 33 | 34 | def _crc8r(data, crc, table): 35 | crc = crc & 0xFF 36 | for x in data: 37 | crc = table[ord(x) ^ crc] 38 | return crc 39 | 40 | def _crc16(data, crc, table): 41 | crc = crc & 0xFFFF 42 | for x in data: 43 | crc = table[ord(x) ^ ((crc>>8) & 0xFF)] ^ ((crc << 8) & 0xFF00) 44 | return crc 45 | 46 | def _crc16r(data, crc, table): 47 | crc = crc & 0xFFFF 48 | for x in data: 49 | crc = table[ord(x) ^ (crc & 0xFF)] ^ (crc >> 8) 50 | return crc 51 | 52 | def _crc24(data, crc, table): 53 | crc = crc & 0xFFFFFF 54 | for x in data: 55 | crc = table[ord(x) ^ (int(crc>>16) & 0xFF)] ^ ((crc << 8) & 0xFFFF00) 56 | return crc 57 | 58 | def _crc24r(data, crc, table): 59 | crc = crc & 0xFFFFFF 60 | for x in data: 61 | crc = table[ord(x) ^ int(crc & 0xFF)] ^ (crc >> 8) 62 | return crc 63 | 64 | def _crc32(data, crc, table): 65 | crc = crc & 0xFFFFFFFFL 66 | for x in data: 67 | crc = table[ord(x) ^ (int(crc>>24) & 0xFF)] ^ ((crc << 8) & 0xFFFFFF00L) 68 | return crc 69 | 70 | def _crc32r(data, crc, table): 71 | crc = crc & 0xFFFFFFFFL 72 | for x in data: 73 | crc = table[ord(x) ^ int(crc & 0xFFL)] ^ (crc >> 8) 74 | return crc 75 | 76 | def _crc64(data, crc, table): 77 | crc = crc & 0xFFFFFFFFFFFFFFFFL 78 | for x in data: 79 | crc = table[ord(x) ^ (int(crc>>56) & 0xFF)] ^ ((crc << 8) & 0xFFFFFFFFFFFFFF00L) 80 | return crc 81 | 82 | def _crc64r(data, crc, table): 83 | crc = crc & 0xFFFFFFFFFFFFFFFFL 84 | for x in data: 85 | crc = table[ord(x) ^ int(crc & 0xFFL)] ^ (crc >> 8) 86 | return crc 87 | 88 | -------------------------------------------------------------------------------- /crcmod/_crcfunpy.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nrodofile/ScapyDNP3_lib/70902fce1a1feb5c6be77ec3503620e54f41887a/crcmod/_crcfunpy.pyc -------------------------------------------------------------------------------- /crcmod/crcmod.py: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------------- 2 | # Copyright (c) 2010 Raymond L. Buvel 3 | # Copyright (c) 2010 Craig McQueen 4 | # 5 | # Permission is hereby granted, free of charge, to any person obtaining a copy 6 | # of this software and associated documentation files (the "Software"), to deal 7 | # in the Software without restriction, including without limitation the rights 8 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | # copies of the Software, and to permit persons to whom the Software is 10 | # furnished to do so, subject to the following conditions: 11 | # 12 | # The above copyright notice and this permission notice shall be included in 13 | # all copies or substantial portions of the Software. 14 | # 15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | # SOFTWARE. 22 | #----------------------------------------------------------------------------- 23 | '''crcmod is a Python module for gererating objects that compute the Cyclic 24 | Redundancy Check. Any 8, 16, 24, 32, or 64 bit polynomial can be used. 25 | 26 | The following are the public components of this module. 27 | 28 | Crc -- a class that creates instances providing the same interface as the 29 | md5 and sha modules in the Python standard library. These instances also 30 | provide a method for generating a C/C++ function to compute the CRC. 31 | 32 | mkCrcFun -- create a Python function to compute the CRC using the specified 33 | polynomial and initial value. This provides a much simpler interface if 34 | all you need is a function for CRC calculation. 35 | ''' 36 | 37 | __all__ = '''mkCrcFun Crc 38 | '''.split() 39 | 40 | # Select the appropriate set of low-level CRC functions for this installation. 41 | # If the extension module was not built, drop back to the Python implementation 42 | # even though it is significantly slower. 43 | try: 44 | import _crcfunext as _crcfun 45 | _usingExtension = True 46 | except ImportError: 47 | import _crcfunpy as _crcfun 48 | _usingExtension = False 49 | 50 | import sys, struct 51 | 52 | #----------------------------------------------------------------------------- 53 | class Crc: 54 | '''Compute a Cyclic Redundancy Check (CRC) using the specified polynomial. 55 | 56 | Instances of this class have the same interface as the md5 and sha modules 57 | in the Python standard library. See the documentation for these modules 58 | for examples of how to use a Crc instance. 59 | 60 | The string representation of a Crc instance identifies the polynomial, 61 | initial value, XOR out value, and the current CRC value. The print 62 | statement can be used to output this information. 63 | 64 | If you need to generate a C/C++ function for use in another application, 65 | use the generateCode method. If you need to generate code for another 66 | language, subclass Crc and override the generateCode method. 67 | 68 | The following are the parameters supplied to the constructor. 69 | 70 | poly -- The generator polynomial to use in calculating the CRC. The value 71 | is specified as a Python integer or long integer. The bits in this integer 72 | are the coefficients of the polynomial. The only polynomials allowed are 73 | those that generate 8, 16, 24, 32, or 64 bit CRCs. 74 | 75 | initCrc -- Initial value used to start the CRC calculation. This initial 76 | value should be the initial shift register value XORed with the final XOR 77 | value. That is equivalent to the CRC result the algorithm should return for 78 | a zero-length string. Defaults to all bits set because that starting value 79 | will take leading zero bytes into account. Starting with zero will ignore 80 | all leading zero bytes. 81 | 82 | rev -- A flag that selects a bit reversed algorithm when True. Defaults to 83 | True because the bit reversed algorithms are more efficient. 84 | 85 | xorOut -- Final value to XOR with the calculated CRC value. Used by some 86 | CRC algorithms. Defaults to zero. 87 | ''' 88 | def __init__(self, poly, initCrc=~0L, rev=True, xorOut=0, initialize=True): 89 | if not initialize: 90 | # Don't want to perform the initialization when using new or copy 91 | # to create a new instance. 92 | return 93 | 94 | (sizeBits, initCrc, xorOut) = _verifyParams(poly, initCrc, xorOut) 95 | self.digest_size = sizeBits//8 96 | self.initCrc = initCrc 97 | self.xorOut = xorOut 98 | 99 | self.poly = poly 100 | self.reverse = rev 101 | 102 | (crcfun, table) = _mkCrcFun(poly, sizeBits, initCrc, rev, xorOut) 103 | self._crc = crcfun 104 | self.table = table 105 | 106 | self.crcValue = self.initCrc 107 | 108 | def __str__(self): 109 | lst = [] 110 | lst.append('poly = 0x%X' % self.poly) 111 | lst.append('reverse = %s' % self.reverse) 112 | fmt = '0x%%0%dX' % (self.digest_size*2) 113 | lst.append('initCrc = %s' % (fmt % self.initCrc)) 114 | lst.append('xorOut = %s' % (fmt % self.xorOut)) 115 | lst.append('crcValue = %s' % (fmt % self.crcValue)) 116 | return '\n'.join(lst) 117 | 118 | def new(self, arg=None): 119 | '''Create a new instance of the Crc class initialized to the same 120 | values as the original instance. The current CRC is set to the initial 121 | value. If a string is provided in the optional arg parameter, it is 122 | passed to the update method. 123 | ''' 124 | n = Crc(poly=None, initialize=False) 125 | n._crc = self._crc 126 | n.digest_size = self.digest_size 127 | n.initCrc = self.initCrc 128 | n.xorOut = self.xorOut 129 | n.table = self.table 130 | n.crcValue = self.initCrc 131 | n.reverse = self.reverse 132 | n.poly = self.poly 133 | if arg is not None: 134 | n.update(arg) 135 | return n 136 | 137 | def copy(self): 138 | '''Create a new instance of the Crc class initialized to the same 139 | values as the original instance. The current CRC is set to the current 140 | value. This allows multiple CRC calculations using a common initial 141 | string. 142 | ''' 143 | c = self.new() 144 | c.crcValue = self.crcValue 145 | return c 146 | 147 | def update(self, data): 148 | '''Update the current CRC value using the string specified as the data 149 | parameter. 150 | ''' 151 | self.crcValue = self._crc(data, self.crcValue) 152 | 153 | def digest(self): 154 | '''Return the current CRC value as a string of bytes. The length of 155 | this string is specified in the digest_size attribute. 156 | ''' 157 | n = self.digest_size 158 | crc = self.crcValue 159 | lst = [] 160 | while n > 0: 161 | lst.append(chr(crc & 0xFF)) 162 | crc = crc >> 8 163 | n -= 1 164 | lst.reverse() 165 | return ''.join(lst) 166 | 167 | def hexdigest(self): 168 | '''Return the current CRC value as a string of hex digits. The length 169 | of this string is twice the digest_size attribute. 170 | ''' 171 | n = self.digest_size 172 | crc = self.crcValue 173 | lst = [] 174 | while n > 0: 175 | lst.append('%02X' % (crc & 0xFF)) 176 | crc = crc >> 8 177 | n -= 1 178 | lst.reverse() 179 | return ''.join(lst) 180 | 181 | def generateCode(self, functionName, out, dataType=None, crcType=None): 182 | '''Generate a C/C++ function. 183 | 184 | functionName -- String specifying the name of the function. 185 | 186 | out -- An open file-like object with a write method. This specifies 187 | where the generated code is written. 188 | 189 | dataType -- An optional parameter specifying the data type of the input 190 | data to the function. Defaults to UINT8. 191 | 192 | crcType -- An optional parameter specifying the data type of the CRC 193 | value. Defaults to one of UINT8, UINT16, UINT32, or UINT64 depending 194 | on the size of the CRC value. 195 | ''' 196 | if dataType is None: 197 | dataType = 'UINT8' 198 | 199 | if crcType is None: 200 | size = 8*self.digest_size 201 | if size == 24: 202 | size = 32 203 | crcType = 'UINT%d' % size 204 | 205 | if self.digest_size == 1: 206 | # Both 8-bit CRC algorithms are the same 207 | crcAlgor = 'table[*data ^ (%s)crc]' 208 | elif self.reverse: 209 | # The bit reverse algorithms are all the same except for the data 210 | # type of the crc variable which is specified elsewhere. 211 | crcAlgor = 'table[*data ^ (%s)crc] ^ (crc >> 8)' 212 | else: 213 | # The forward CRC algorithms larger than 8 bits have an extra shift 214 | # operation to get the high byte. 215 | shift = 8*(self.digest_size - 1) 216 | crcAlgor = 'table[*data ^ (%%s)(crc >> %d)] ^ (crc << 8)' % shift 217 | 218 | fmt = '0x%%0%dX' % (2*self.digest_size) 219 | if self.digest_size <= 4: 220 | fmt = fmt + 'U,' 221 | else: 222 | # Need the long long type identifier to keep gcc from complaining. 223 | fmt = fmt + 'ULL,' 224 | 225 | # Select the number of entries per row in the output code. 226 | n = {1:8, 2:8, 3:4, 4:4, 8:2}[self.digest_size] 227 | 228 | lst = [] 229 | for i, val in enumerate(self.table): 230 | if (i % n) == 0: 231 | lst.append('\n ') 232 | lst.append(fmt % val) 233 | 234 | poly = 'polynomial: 0x%X' % self.poly 235 | if self.reverse: 236 | poly = poly + ', bit reverse algorithm' 237 | 238 | if self.xorOut: 239 | # Need to remove the comma from the format. 240 | preCondition = '\n crc = crc ^ %s;' % (fmt[:-1] % self.xorOut) 241 | postCondition = preCondition 242 | else: 243 | preCondition = '' 244 | postCondition = '' 245 | 246 | if self.digest_size == 3: 247 | # The 24-bit CRC needs to be conditioned so that only 24-bits are 248 | # used from the 32-bit variable. 249 | if self.reverse: 250 | preCondition += '\n crc = crc & 0xFFFFFFU;' 251 | else: 252 | postCondition += '\n crc = crc & 0xFFFFFFU;' 253 | 254 | 255 | parms = { 256 | 'dataType' : dataType, 257 | 'crcType' : crcType, 258 | 'name' : functionName, 259 | 'crcAlgor' : crcAlgor % dataType, 260 | 'crcTable' : ''.join(lst), 261 | 'poly' : poly, 262 | 'preCondition' : preCondition, 263 | 'postCondition' : postCondition, 264 | } 265 | out.write(_codeTemplate % parms) 266 | 267 | #----------------------------------------------------------------------------- 268 | def mkCrcFun(poly, initCrc=~0L, rev=True, xorOut=0): 269 | '''Return a function that computes the CRC using the specified polynomial. 270 | 271 | poly -- integer representation of the generator polynomial 272 | initCrc -- default initial CRC value 273 | rev -- when true, indicates that the data is processed bit reversed. 274 | xorOut -- the final XOR value 275 | 276 | The returned function has the following user interface 277 | def crcfun(data, crc=initCrc): 278 | ''' 279 | 280 | # First we must verify the params 281 | (sizeBits, initCrc, xorOut) = _verifyParams(poly, initCrc, xorOut) 282 | # Make the function (and table), return the function 283 | return _mkCrcFun(poly, sizeBits, initCrc, rev, xorOut)[0] 284 | 285 | #----------------------------------------------------------------------------- 286 | # Naming convention: 287 | # All function names ending with r are bit reverse variants of the ones 288 | # without the r. 289 | 290 | #----------------------------------------------------------------------------- 291 | # Check the polynomial to make sure that it is acceptable and return the number 292 | # of bits in the CRC. 293 | 294 | def _verifyPoly(poly): 295 | msg = 'The degree of the polynomial must be 8, 16, 24, 32 or 64' 296 | poly = long(poly) # Use a common representation for all operations 297 | for n in (8,16,24,32,64): 298 | low = 1L<> 1 313 | if ((1L<> 1) ^ poly 343 | else: 344 | crc = crc >> 1 345 | mask = (1L< 0) 464 | { 465 | crc = %(crcAlgor)s; 466 | data++; 467 | len--; 468 | }%(postCondition)s 469 | return crc; 470 | } 471 | ''' 472 | 473 | -------------------------------------------------------------------------------- /crcmod/crcmod.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nrodofile/ScapyDNP3_lib/70902fce1a1feb5c6be77ec3503620e54f41887a/crcmod/crcmod.pyc -------------------------------------------------------------------------------- /crcmod/predefined.py: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------------- 2 | # Copyright (c) 2010 Craig McQueen 3 | # 4 | # Permission is hereby granted, free of charge, to any person obtaining a copy 5 | # of this software and associated documentation files (the "Software"), to deal 6 | # in the Software without restriction, including without limitation the rights 7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 | # copies of the Software, and to permit persons to whom the Software is 9 | # furnished to do so, subject to the following conditions: 10 | # 11 | # The above copyright notice and this permission notice shall be included in 12 | # all copies or substantial portions of the Software. 13 | # 14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20 | # SOFTWARE. 21 | #----------------------------------------------------------------------------- 22 | ''' 23 | crcmod.predefined defines some well-known CRC algorithms. 24 | 25 | To use it, e.g.: 26 | import crcmod.predefined 27 | 28 | crc32func = crcmod.predefined.mkPredefinedCrcFun("crc-32") 29 | crc32class = crcmod.predefined.PredefinedCrc("crc-32") 30 | 31 | crcmod.predefined.Crc is an alias for crcmod.predefined.PredefinedCrc 32 | But if doing 'from crc.predefined import *', only PredefinedCrc is imported. 33 | ''' 34 | 35 | # local imports 36 | import crcmod 37 | 38 | __all__ = [ 39 | 'PredefinedCrc', 40 | 'mkPredefinedCrcFun', 41 | ] 42 | 43 | REVERSE = True 44 | NON_REVERSE = False 45 | 46 | # The following table defines the parameters of well-known CRC algorithms. 47 | # The "Check" value is the CRC for the ASCII byte sequence "123456789". It 48 | # can be used for unit tests. 49 | _crc_definitions_table = [ 50 | # Name Identifier-name, Poly Reverse Init-value XOR-out Check 51 | [ 'crc-8', 'Crc8', 0x107, NON_REVERSE, 0x00, 0x00, 0xF4, ], 52 | [ 'crc-8-darc', 'Crc8Darc', 0x139, REVERSE, 0x00, 0x00, 0x15, ], 53 | [ 'crc-8-i-code', 'Crc8ICode', 0x11D, NON_REVERSE, 0xFD, 0x00, 0x7E, ], 54 | [ 'crc-8-itu', 'Crc8Itu', 0x107, NON_REVERSE, 0x55, 0x55, 0xA1, ], 55 | [ 'crc-8-maxim', 'Crc8Maxim', 0x131, REVERSE, 0x00, 0x00, 0xA1, ], 56 | [ 'crc-8-rohc', 'Crc8Rohc', 0x107, REVERSE, 0xFF, 0x00, 0xD0, ], 57 | [ 'crc-8-wcdma', 'Crc8Wcdma', 0x19B, REVERSE, 0x00, 0x00, 0x25, ], 58 | 59 | [ 'crc-16', 'Crc16', 0x18005, REVERSE, 0x0000, 0x0000, 0xBB3D, ], 60 | [ 'crc-16-buypass', 'Crc16Buypass', 0x18005, NON_REVERSE, 0x0000, 0x0000, 0xFEE8, ], 61 | [ 'crc-16-dds-110', 'Crc16Dds110', 0x18005, NON_REVERSE, 0x800D, 0x0000, 0x9ECF, ], 62 | [ 'crc-16-dect', 'Crc16Dect', 0x10589, NON_REVERSE, 0x0001, 0x0001, 0x007E, ], 63 | [ 'crc-16-dnp', 'Crc16Dnp', 0x13D65, REVERSE, 0xFFFF, 0xFFFF, 0xEA82, ], 64 | [ 'crc-16-en-13757', 'Crc16En13757', 0x13D65, NON_REVERSE, 0xFFFF, 0xFFFF, 0xC2B7, ], 65 | [ 'crc-16-genibus', 'Crc16Genibus', 0x11021, NON_REVERSE, 0x0000, 0xFFFF, 0xD64E, ], 66 | [ 'crc-16-maxim', 'Crc16Maxim', 0x18005, REVERSE, 0xFFFF, 0xFFFF, 0x44C2, ], 67 | [ 'crc-16-mcrf4xx', 'Crc16Mcrf4xx', 0x11021, REVERSE, 0xFFFF, 0x0000, 0x6F91, ], 68 | [ 'crc-16-riello', 'Crc16Riello', 0x11021, REVERSE, 0x554D, 0x0000, 0x63D0, ], 69 | [ 'crc-16-t10-dif', 'Crc16T10Dif', 0x18BB7, NON_REVERSE, 0x0000, 0x0000, 0xD0DB, ], 70 | [ 'crc-16-teledisk', 'Crc16Teledisk', 0x1A097, NON_REVERSE, 0x0000, 0x0000, 0x0FB3, ], 71 | [ 'crc-16-usb', 'Crc16Usb', 0x18005, REVERSE, 0x0000, 0xFFFF, 0xB4C8, ], 72 | [ 'x-25', 'CrcX25', 0x11021, REVERSE, 0x0000, 0xFFFF, 0x906E, ], 73 | [ 'xmodem', 'CrcXmodem', 0x11021, NON_REVERSE, 0x0000, 0x0000, 0x31C3, ], 74 | [ 'modbus', 'CrcModbus', 0x18005, REVERSE, 0xFFFF, 0x0000, 0x4B37, ], 75 | 76 | # Note definitions of CCITT are disputable. See: 77 | # http://homepages.tesco.net/~rainstorm/crc-catalogue.htm 78 | # http://web.archive.org/web/20071229021252/http://www.joegeluso.com/software/articles/ccitt.htm 79 | [ 'kermit', 'CrcKermit', 0x11021, REVERSE, 0x0000, 0x0000, 0x2189, ], 80 | [ 'crc-ccitt-false', 'CrcCcittFalse', 0x11021, NON_REVERSE, 0xFFFF, 0x0000, 0x29B1, ], 81 | [ 'crc-aug-ccitt', 'CrcAugCcitt', 0x11021, NON_REVERSE, 0x1D0F, 0x0000, 0xE5CC, ], 82 | 83 | [ 'crc-24', 'Crc24', 0x1864CFB, NON_REVERSE, 0xB704CE, 0x000000, 0x21CF02, ], 84 | [ 'crc-24-flexray-a', 'Crc24FlexrayA', 0x15D6DCB, NON_REVERSE, 0xFEDCBA, 0x000000, 0x7979BD, ], 85 | [ 'crc-24-flexray-b', 'Crc24FlexrayB', 0x15D6DCB, NON_REVERSE, 0xABCDEF, 0x000000, 0x1F23B8, ], 86 | 87 | [ 'crc-32', 'Crc32', 0x104C11DB7, REVERSE, 0x00000000, 0xFFFFFFFF, 0xCBF43926, ], 88 | [ 'crc-32-bzip2', 'Crc32Bzip2', 0x104C11DB7, NON_REVERSE, 0x00000000, 0xFFFFFFFF, 0xFC891918, ], 89 | [ 'crc-32c', 'Crc32C', 0x11EDC6F41, REVERSE, 0x00000000, 0xFFFFFFFF, 0xE3069283, ], 90 | [ 'crc-32d', 'Crc32D', 0x1A833982B, REVERSE, 0x00000000, 0xFFFFFFFF, 0x87315576, ], 91 | [ 'crc-32-mpeg', 'Crc32Mpeg', 0x104C11DB7, NON_REVERSE, 0xFFFFFFFF, 0x00000000, 0x0376E6E7, ], 92 | [ 'posix', 'CrcPosix', 0x104C11DB7, NON_REVERSE, 0xFFFFFFFF, 0xFFFFFFFF, 0x765E7680, ], 93 | [ 'crc-32q', 'Crc32Q', 0x1814141AB, NON_REVERSE, 0x00000000, 0x00000000, 0x3010BF7F, ], 94 | [ 'jamcrc', 'CrcJamCrc', 0x104C11DB7, REVERSE, 0xFFFFFFFF, 0x00000000, 0x340BC6D9, ], 95 | [ 'xfer', 'CrcXfer', 0x1000000AF, NON_REVERSE, 0x00000000, 0x00000000, 0xBD0BE338, ], 96 | 97 | # 64-bit 98 | # Name Identifier-name, Poly Reverse Init-value XOR-out Check 99 | [ 'crc-64', 'Crc64', 0x1000000000000001B, REVERSE, 0x0000000000000000, 0x0000000000000000, 0x46A5A9388A5BEFFE, ], 100 | [ 'crc-64-we', 'Crc64We', 0x142F0E1EBA9EA3693, NON_REVERSE, 0x0000000000000000, 0xFFFFFFFFFFFFFFFF, 0x62EC59E3F1A4F00A, ], 101 | [ 'crc-64-jones', 'Crc64Jones', 0x1AD93D23594C935A9, REVERSE, 0xFFFFFFFFFFFFFFFF, 0x0000000000000000, 0xCAA717168609F281, ], 102 | ] 103 | 104 | 105 | def _simplify_name(name): 106 | """ 107 | Reduce CRC definition name to a simplified form: 108 | * lowercase 109 | * dashes removed 110 | * spaces removed 111 | * any initial "CRC" string removed 112 | """ 113 | name = name.lower() 114 | name = name.replace('-', '') 115 | name = name.replace(' ', '') 116 | if name.startswith('crc'): 117 | name = name[len('crc'):] 118 | return name 119 | 120 | 121 | _crc_definitions_by_name = {} 122 | _crc_definitions_by_identifier = {} 123 | _crc_definitions = [] 124 | 125 | _crc_table_headings = [ 'name', 'identifier', 'poly', 'reverse', 'init', 'xor_out', 'check' ] 126 | 127 | for table_entry in _crc_definitions_table: 128 | crc_definition = dict(zip(_crc_table_headings, table_entry)) 129 | _crc_definitions.append(crc_definition) 130 | name = _simplify_name(table_entry[0]) 131 | if name in _crc_definitions_by_name: 132 | raise Exception("Duplicate entry for '%s' in CRC table" % name) 133 | _crc_definitions_by_name[name] = crc_definition 134 | _crc_definitions_by_identifier[table_entry[1]] = crc_definition 135 | 136 | 137 | def _get_definition_by_name(crc_name): 138 | definition = _crc_definitions_by_name.get(_simplify_name(crc_name), None) 139 | if not definition: 140 | definition = _crc_definitions_by_identifier.get(crc_name, None) 141 | if not definition: 142 | raise KeyError("Unkown CRC name '%s'" % crc_name) 143 | return definition 144 | 145 | 146 | class PredefinedCrc(crcmod.Crc): 147 | def __init__(self, crc_name): 148 | definition = _get_definition_by_name(crc_name) 149 | crcmod.Crc.__init__(self, poly=definition['poly'], initCrc=definition['init'], rev=definition['reverse'], xorOut=definition['xor_out']) 150 | 151 | 152 | # crcmod.predefined.Crc is an alias for crcmod.predefined.PredefinedCrc 153 | Crc = PredefinedCrc 154 | 155 | 156 | def mkPredefinedCrcFun(crc_name): 157 | definition = _get_definition_by_name(crc_name) 158 | return crcmod.mkCrcFun(poly=definition['poly'], initCrc=definition['init'], rev=definition['reverse'], xorOut=definition['xor_out']) 159 | 160 | 161 | # crcmod.predefined.mkCrcFun is an alias for crcmod.predefined.mkPredefinedCrcFun 162 | mkCrcFun = mkPredefinedCrcFun 163 | -------------------------------------------------------------------------------- /crcmod/predefined.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nrodofile/ScapyDNP3_lib/70902fce1a1feb5c6be77ec3503620e54f41887a/crcmod/predefined.pyc -------------------------------------------------------------------------------- /crcmod/test.py: -------------------------------------------------------------------------------- 1 | #----------------------------------------------------------------------------- 2 | # Copyright (c) 2010 Raymond L. Buvel 3 | # Copyright (c) 2010 Craig McQueen 4 | # 5 | # Permission is hereby granted, free of charge, to any person obtaining a copy 6 | # of this software and associated documentation files (the "Software"), to deal 7 | # in the Software without restriction, including without limitation the rights 8 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | # copies of the Software, and to permit persons to whom the Software is 10 | # furnished to do so, subject to the following conditions: 11 | # 12 | # The above copyright notice and this permission notice shall be included in 13 | # all copies or substantial portions of the Software. 14 | # 15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | # SOFTWARE. 22 | #----------------------------------------------------------------------------- 23 | '''Unit tests for crcmod functionality''' 24 | 25 | 26 | import unittest 27 | 28 | import binascii 29 | 30 | from crcmod import mkCrcFun, Crc 31 | try: 32 | from crcmod.crcmod import _usingExtension 33 | from crcmod.predefined import PredefinedCrc 34 | from crcmod.predefined import mkPredefinedCrcFun 35 | from crcmod.predefined import _crc_definitions as _predefined_crc_definitions 36 | except ImportError: 37 | from crcmod import _usingExtension 38 | from predefined import PredefinedCrc 39 | from predefined import mkPredefinedCrcFun 40 | from predefined import _crc_definitions as _predefined_crc_definitions 41 | 42 | 43 | #----------------------------------------------------------------------------- 44 | # This polynomial was chosen because it is the product of two irreducible 45 | # polynomials. 46 | # g8 = (x^7+x+1)*(x+1) 47 | g8 = 0x185 48 | 49 | #----------------------------------------------------------------------------- 50 | # The following reproduces all of the entries in the Numerical Recipes table. 51 | # This is the standard CCITT polynomial. 52 | g16 = 0x11021 53 | 54 | #----------------------------------------------------------------------------- 55 | g24 = 0x15D6DCB 56 | 57 | #----------------------------------------------------------------------------- 58 | # This is the standard AUTODIN-II polynomial which appears to be used in a 59 | # wide variety of standards and applications. 60 | g32 = 0x104C11DB7 61 | 62 | 63 | #----------------------------------------------------------------------------- 64 | # I was able to locate a couple of 64-bit polynomials on the web. To make it 65 | # easier to input the representation, define a function that builds a 66 | # polynomial from a list of the bits that need to be turned on. 67 | 68 | def polyFromBits(bits): 69 | p = 0L 70 | for n in bits: 71 | p = p | (1L << n) 72 | return p 73 | 74 | # The following is from the paper "An Improved 64-bit Cyclic Redundancy Check 75 | # for Protein Sequences" by David T. Jones 76 | 77 | g64a = polyFromBits([64, 63, 61, 59, 58, 56, 55, 52, 49, 48, 47, 46, 44, 41, 78 | 37, 36, 34, 32, 31, 28, 26, 23, 22, 19, 16, 13, 12, 10, 9, 6, 4, 79 | 3, 0]) 80 | 81 | # The following is from Standard ECMA-182 "Data Interchange on 12,7 mm 48-Track 82 | # Magnetic Tape Cartridges -DLT1 Format-", December 1992. 83 | 84 | g64b = polyFromBits([64, 62, 57, 55, 54, 53, 52, 47, 46, 45, 40, 39, 38, 37, 85 | 35, 33, 32, 31, 29, 27, 24, 23, 22, 21, 19, 17, 13, 12, 10, 9, 7, 86 | 4, 1, 0]) 87 | 88 | #----------------------------------------------------------------------------- 89 | # This class is used to check the CRC calculations against a direct 90 | # implementation using polynomial division. 91 | 92 | class poly: 93 | '''Class implementing polynomials over the field of integers mod 2''' 94 | def __init__(self,p): 95 | p = long(p) 96 | if p < 0: raise ValueError('invalid polynomial') 97 | self.p = p 98 | 99 | def __long__(self): 100 | return self.p 101 | 102 | def __eq__(self,other): 103 | return self.p == other.p 104 | 105 | def __ne__(self,other): 106 | return self.p != other.p 107 | 108 | # To allow sorting of polynomials, use their long integer form for 109 | # comparison 110 | def __cmp__(self,other): 111 | return cmp(self.p, other.p) 112 | 113 | def __nonzero__(self): 114 | return self.p != 0L 115 | 116 | def __neg__(self): 117 | return self # These polynomials are their own inverse under addition 118 | 119 | def __invert__(self): 120 | n = max(self.deg() + 1, 1) 121 | x = (1L << n) - 1 122 | return poly(self.p ^ x) 123 | 124 | def __add__(self,other): 125 | return poly(self.p ^ other.p) 126 | 127 | def __sub__(self,other): 128 | return poly(self.p ^ other.p) 129 | 130 | def __mul__(self,other): 131 | a = self.p 132 | b = other.p 133 | if a == 0 or b == 0: return poly(0) 134 | x = 0L 135 | while b: 136 | if b&1: 137 | x = x ^ a 138 | a = a<<1 139 | b = b>>1 140 | return poly(x) 141 | 142 | def __divmod__(self,other): 143 | u = self.p 144 | m = self.deg() 145 | v = other.p 146 | n = other.deg() 147 | if v == 0: raise ZeroDivisionError('polynomial division by zero') 148 | if n == 0: return (self,poly(0)) 149 | if m < n: return (poly(0),self) 150 | k = m-n 151 | a = 1L << m 152 | v = v << k 153 | q = 0L 154 | while k > 0: 155 | if a & u: 156 | u = u ^ v 157 | q = q | 1L 158 | q = q << 1 159 | a = a >> 1 160 | v = v >> 1 161 | k -= 1 162 | if a & u: 163 | u = u ^ v 164 | q = q | 1L 165 | return (poly(q),poly(u)) 166 | 167 | def __div__(self,other): 168 | return self.__divmod__(other)[0] 169 | 170 | def __mod__(self,other): 171 | return self.__divmod__(other)[1] 172 | 173 | def __repr__(self): 174 | return 'poly(0x%XL)' % self.p 175 | 176 | def __str__(self): 177 | p = self.p 178 | if p == 0: return '0' 179 | lst = { 0:[], 1:['1'], 2:['x'], 3:['1','x'] }[p&3] 180 | p = p>>2 181 | n = 2 182 | while p: 183 | if p&1: lst.append('x^%d' % n) 184 | p = p>>1 185 | n += 1 186 | lst.reverse() 187 | return '+'.join(lst) 188 | 189 | def deg(self): 190 | '''return the degree of the polynomial''' 191 | a = self.p 192 | if a == 0: return -1 193 | n = 0 194 | while a >= 0x10000L: 195 | n += 16 196 | a = a >> 16 197 | a = int(a) 198 | while a > 1: 199 | n += 1 200 | a = a >> 1 201 | return n 202 | 203 | #----------------------------------------------------------------------------- 204 | # The following functions compute the CRC using direct polynomial division. 205 | # These functions are checked against the result of the table driven 206 | # algorithms. 207 | 208 | g8p = poly(g8) 209 | x8p = poly(1L<<8) 210 | def crc8p(d): 211 | d = map(ord, d) 212 | p = 0L 213 | for i in d: 214 | p = p*256L + i 215 | p = poly(p) 216 | return long(p*x8p%g8p) 217 | 218 | g16p = poly(g16) 219 | x16p = poly(1L<<16) 220 | def crc16p(d): 221 | d = map(ord, d) 222 | p = 0L 223 | for i in d: 224 | p = p*256L + i 225 | p = poly(p) 226 | return long(p*x16p%g16p) 227 | 228 | g24p = poly(g24) 229 | x24p = poly(1L<<24) 230 | def crc24p(d): 231 | d = map(ord, d) 232 | p = 0L 233 | for i in d: 234 | p = p*256L + i 235 | p = poly(p) 236 | return long(p*x24p%g24p) 237 | 238 | g32p = poly(g32) 239 | x32p = poly(1L<<32) 240 | def crc32p(d): 241 | d = map(ord, d) 242 | p = 0L 243 | for i in d: 244 | p = p*256L + i 245 | p = poly(p) 246 | return long(p*x32p%g32p) 247 | 248 | g64ap = poly(g64a) 249 | x64p = poly(1L<<64) 250 | def crc64ap(d): 251 | d = map(ord, d) 252 | p = 0L 253 | for i in d: 254 | p = p*256L + i 255 | p = poly(p) 256 | return long(p*x64p%g64ap) 257 | 258 | g64bp = poly(g64b) 259 | def crc64bp(d): 260 | d = map(ord, d) 261 | p = 0L 262 | for i in d: 263 | p = p*256L + i 264 | p = poly(p) 265 | return long(p*x64p%g64bp) 266 | 267 | 268 | class KnownAnswerTests(unittest.TestCase): 269 | test_messages = [ 270 | 'T', 271 | 'CatMouse987654321', 272 | ] 273 | 274 | known_answers = [ 275 | [ (g8,0,0), (0xFE, 0x9D) ], 276 | [ (g8,-1,1), (0x4F, 0x9B) ], 277 | [ (g8,0,1), (0xFE, 0x62) ], 278 | [ (g16,0,0), (0x1A71, 0xE556) ], 279 | [ (g16,-1,1), (0x1B26, 0xF56E) ], 280 | [ (g16,0,1), (0x14A1, 0xC28D) ], 281 | [ (g24,0,0), (0xBCC49D, 0xC4B507) ], 282 | [ (g24,-1,1), (0x59BD0E, 0x0AAA37) ], 283 | [ (g24,0,1), (0xD52B0F, 0x1523AB) ], 284 | [ (g32,0,0), (0x6B93DDDB, 0x12DCA0F4) ], 285 | [ (g32,0xFFFFFFFFL,1), (0x41FB859FL, 0xF7B400A7L) ], 286 | [ (g32,0,1), (0x6C0695EDL, 0xC1A40EE5L) ], 287 | [ (g32,0,1,0xFFFFFFFF), (0xBE047A60L, 0x084BFF58L) ], 288 | ] 289 | 290 | def test_known_answers(self): 291 | for crcfun_params, v in self.known_answers: 292 | crcfun = mkCrcFun(*crcfun_params) 293 | self.assertEqual(crcfun('',0), 0, "Wrong answer for CRC parameters %s, input ''" % (crcfun_params,)) 294 | for i, msg in enumerate(self.test_messages): 295 | self.assertEqual(crcfun(msg), v[i], "Wrong answer for CRC parameters %s, input '%s'" % (crcfun_params,msg)) 296 | self.assertEqual(crcfun(msg[4:], crcfun(msg[:4])), v[i], "Wrong answer for CRC parameters %s, input '%s'" % (crcfun_params,msg)) 297 | self.assertEqual(crcfun(msg[-1:], crcfun(msg[:-1])), v[i], "Wrong answer for CRC parameters %s, input '%s'" % (crcfun_params,msg)) 298 | 299 | 300 | class CompareReferenceCrcTest(unittest.TestCase): 301 | test_messages = [ 302 | '', 303 | 'T', 304 | '123456789', 305 | 'CatMouse987654321', 306 | ] 307 | 308 | test_poly_crcs = [ 309 | [ (g8,0,0), crc8p ], 310 | [ (g16,0,0), crc16p ], 311 | [ (g24,0,0), crc24p ], 312 | [ (g32,0,0), crc32p ], 313 | [ (g64a,0,0), crc64ap ], 314 | [ (g64b,0,0), crc64bp ], 315 | ] 316 | 317 | @staticmethod 318 | def reference_crc32(d, crc=0): 319 | """This function modifies the return value of binascii.crc32 320 | to be an unsigned 32-bit value. I.e. in the range 0 to 2**32-1.""" 321 | # Work around the future warning on constants. 322 | if crc > 0x7FFFFFFFL: 323 | x = int(crc & 0x7FFFFFFFL) 324 | crc = x | -2147483648 325 | x = binascii.crc32(d,crc) 326 | return long(x) & 0xFFFFFFFFL 327 | 328 | def test_compare_crc32(self): 329 | """The binascii module has a 32-bit CRC function that is used in a wide range 330 | of applications including the checksum used in the ZIP file format. 331 | This test compares the CRC-32 implementation of this crcmod module to 332 | that of binascii.crc32.""" 333 | # The following function should produce the same result as 334 | # self.reference_crc32 which is derived from binascii.crc32. 335 | crc32 = mkCrcFun(g32,0,1,0xFFFFFFFF) 336 | 337 | for msg in self.test_messages: 338 | self.assertEqual(crc32(msg), self.reference_crc32(msg)) 339 | 340 | def test_compare_poly(self): 341 | """Compare various CRCs of this crcmod module to a pure 342 | polynomial-based implementation.""" 343 | for crcfun_params, crc_poly_fun in self.test_poly_crcs: 344 | # The following function should produce the same result as 345 | # the associated polynomial CRC function. 346 | crcfun = mkCrcFun(*crcfun_params) 347 | 348 | for msg in self.test_messages: 349 | self.assertEqual(crcfun(msg), crc_poly_fun(msg)) 350 | 351 | 352 | class CrcClassTest(unittest.TestCase): 353 | """Verify the Crc class""" 354 | 355 | msg = 'CatMouse987654321' 356 | 357 | def test_simple_crc32_class(self): 358 | """Verify the CRC class when not using xorOut""" 359 | crc = Crc(g32) 360 | 361 | str_rep = \ 362 | '''poly = 0x104C11DB7 363 | reverse = True 364 | initCrc = 0xFFFFFFFF 365 | xorOut = 0x00000000 366 | crcValue = 0xFFFFFFFF''' 367 | self.assertEqual(str(crc), str_rep) 368 | self.assertEqual(crc.digest(), '\xff\xff\xff\xff') 369 | self.assertEqual(crc.hexdigest(), 'FFFFFFFF') 370 | 371 | crc.update(self.msg) 372 | self.assertEqual(crc.crcValue, 0xF7B400A7L) 373 | self.assertEqual(crc.digest(), '\xf7\xb4\x00\xa7') 374 | self.assertEqual(crc.hexdigest(), 'F7B400A7') 375 | 376 | # Verify the .copy() method 377 | x = crc.copy() 378 | self.assertTrue(x is not crc) 379 | str_rep = \ 380 | '''poly = 0x104C11DB7 381 | reverse = True 382 | initCrc = 0xFFFFFFFF 383 | xorOut = 0x00000000 384 | crcValue = 0xF7B400A7''' 385 | self.assertEqual(str(crc), str_rep) 386 | self.assertEqual(str(x), str_rep) 387 | 388 | def test_full_crc32_class(self): 389 | """Verify the CRC class when using xorOut""" 390 | 391 | crc = Crc(g32, initCrc=0, xorOut= ~0L) 392 | 393 | str_rep = \ 394 | '''poly = 0x104C11DB7 395 | reverse = True 396 | initCrc = 0x00000000 397 | xorOut = 0xFFFFFFFF 398 | crcValue = 0x00000000''' 399 | self.assertEqual(str(crc), str_rep) 400 | self.assertEqual(crc.digest(), '\x00\x00\x00\x00') 401 | self.assertEqual(crc.hexdigest(), '00000000') 402 | 403 | crc.update(self.msg) 404 | self.assertEqual(crc.crcValue, 0x84BFF58L) 405 | self.assertEqual(crc.digest(), '\x08\x4b\xff\x58') 406 | self.assertEqual(crc.hexdigest(), '084BFF58') 407 | 408 | # Verify the .copy() method 409 | x = crc.copy() 410 | self.assertTrue(x is not crc) 411 | str_rep = \ 412 | '''poly = 0x104C11DB7 413 | reverse = True 414 | initCrc = 0x00000000 415 | xorOut = 0xFFFFFFFF 416 | crcValue = 0x084BFF58''' 417 | self.assertEqual(str(crc), str_rep) 418 | self.assertEqual(str(x), str_rep) 419 | 420 | # Verify the .new() method 421 | y = crc.new() 422 | self.assertTrue(y is not crc) 423 | self.assertTrue(y is not x) 424 | str_rep = \ 425 | '''poly = 0x104C11DB7 426 | reverse = True 427 | initCrc = 0x00000000 428 | xorOut = 0xFFFFFFFF 429 | crcValue = 0x00000000''' 430 | self.assertEqual(str(y), str_rep) 431 | 432 | 433 | class PredefinedCrcTest(unittest.TestCase): 434 | """Verify the predefined CRCs""" 435 | 436 | test_messages_for_known_answers = [ 437 | '', # Test cases below depend on this first entry being the empty string. 438 | 'T', 439 | 'CatMouse987654321', 440 | ] 441 | 442 | known_answers = [ 443 | [ 'crc-aug-ccitt', (0x1D0F, 0xD6ED, 0x5637) ], 444 | [ 'x-25', (0x0000, 0xE4D9, 0x0A91) ], 445 | [ 'crc-32', (0x00000000, 0xBE047A60, 0x084BFF58) ], 446 | ] 447 | 448 | def test_known_answers(self): 449 | for crcfun_name, v in self.known_answers: 450 | crcfun = mkPredefinedCrcFun(crcfun_name) 451 | self.assertEqual(crcfun('',0), 0, "Wrong answer for CRC '%s', input ''" % crcfun_name) 452 | for i, msg in enumerate(self.test_messages_for_known_answers): 453 | self.assertEqual(crcfun(msg), v[i], "Wrong answer for CRC %s, input '%s'" % (crcfun_name,msg)) 454 | self.assertEqual(crcfun(msg[4:], crcfun(msg[:4])), v[i], "Wrong answer for CRC %s, input '%s'" % (crcfun_name,msg)) 455 | self.assertEqual(crcfun(msg[-1:], crcfun(msg[:-1])), v[i], "Wrong answer for CRC %s, input '%s'" % (crcfun_name,msg)) 456 | 457 | def test_class_with_known_answers(self): 458 | for crcfun_name, v in self.known_answers: 459 | for i, msg in enumerate(self.test_messages_for_known_answers): 460 | crc1 = PredefinedCrc(crcfun_name) 461 | crc1.update(msg) 462 | self.assertEqual(crc1.crcValue, v[i], "Wrong answer for crc1 %s, input '%s'" % (crcfun_name,msg)) 463 | 464 | crc2 = crc1.new() 465 | # Check that crc1 maintains its same value, after .new() call. 466 | self.assertEqual(crc1.crcValue, v[i], "Wrong state for crc1 %s, input '%s'" % (crcfun_name,msg)) 467 | # Check that the new class instance created by .new() contains the initialisation value. 468 | # This depends on the first string in self.test_messages_for_known_answers being 469 | # the empty string. 470 | self.assertEqual(crc2.crcValue, v[0], "Wrong state for crc2 %s, input '%s'" % (crcfun_name,msg)) 471 | 472 | crc2.update(msg) 473 | # Check that crc1 maintains its same value, after crc2 has called .update() 474 | self.assertEqual(crc1.crcValue, v[i], "Wrong state for crc1 %s, input '%s'" % (crcfun_name,msg)) 475 | # Check that crc2 contains the right value after calling .update() 476 | self.assertEqual(crc2.crcValue, v[i], "Wrong state for crc2 %s, input '%s'" % (crcfun_name,msg)) 477 | 478 | def test_function_predefined_table(self): 479 | for table_entry in _predefined_crc_definitions: 480 | # Check predefined function 481 | crc_func = mkPredefinedCrcFun(table_entry['name']) 482 | calc_value = crc_func("123456789") 483 | self.assertEqual(calc_value, table_entry['check'], "Wrong answer for CRC '%s'" % table_entry['name']) 484 | 485 | def test_class_predefined_table(self): 486 | for table_entry in _predefined_crc_definitions: 487 | # Check predefined class 488 | crc1 = PredefinedCrc(table_entry['name']) 489 | crc1.update("123456789") 490 | self.assertEqual(crc1.crcValue, table_entry['check'], "Wrong answer for CRC '%s'" % table_entry['name']) 491 | 492 | 493 | def runtests(): 494 | print "Using extension:", _usingExtension 495 | print 496 | unittest.main() 497 | 498 | 499 | if __name__ == '__main__': 500 | runtests() 501 | --------------------------------------------------------------------------------