crc16

Documentation

Overview

Package crc16 is implementation according to CCITT standards.

Note by @antirez: this is actually the XMODEM CRC 16 algorithm, using the following parameters:

Name : "XMODEM", also known as "ZMODEM", "CRC-16/ACORN" Width : 16 bit Poly : 1021 (That is actually x^16 + x^12 + x^5 + 1) Initialization : 0000 Reflect Input byte : False Reflect Output CRC : False Xor constant to output CRC : 0000 Output for "123456789" : 31C3

ported from the c++ code in the hcnet-core codebase (https://github.com/shantanu-hashcash/hcnet-core). The code is licensed as:

• Copyright 2001-2010 Georges Menie (www.menie.org)
• Copyright 2010-2012 Salvatore Sanfilippo (adapted to Redis coding style)
• Copyright 2015 Hcnet Development Foundation (ported to go)
• All rights reserved. *
• Redistribution and use in source and binary forms, with or without
• modification, are permitted provided that the following conditions are met: *
• * Redistributions of source code must retain the above copyright
• notice, this list of conditions and the following disclaimer.
• * Redistributions in binary form must reproduce the above copyright
• notice, this list of conditions and the following disclaimer in the
• documentation and/or other materials provided with the distribution.
• * Neither the name of the University of California, Berkeley nor the
• names of its contributors may be used to endorse or promote products
• derived from this software without specific prior written permission. *
• THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS “AS IS” AND ANY
• EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
• WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
• DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
• DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
• (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
• LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
• ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
• (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
• SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• Variables
• func Checksum(data []byte) uint16
• func Validate(data []byte, expected uint16) error

Variables

var ErrInvalidChecksum = errors.New("invalid checksum")

ErrInvalidChecksum is returned when Validate determines either the checksum or the payload has been corrupted

Functions

func Checksum

func Checksum(data []byte) uint16

Checksum returns the 2-byte checksum for the provided data

func Validate

func Validate(data []byte, expected uint16) error

Validate returns an error if the provided checksum does not match the calculated checksum of the provided data