diff --git a/Data/RFC1751.hs b/Data/RFC1751.hs new file mode 100644 --- /dev/null +++ b/Data/RFC1751.hs @@ -0,0 +1,311 @@ +-- | RFC-1751 human-readable 128-bit keys +module Data.RFC1751 + ( HumanKey() + , humanKey + ) where + +import Data.Binary +import Data.Bits +import Data.Char +import Data.List + +maybeToEither :: b -> Maybe a -> Either b a +maybeToEither err m = maybe (Left err) Right m + +assertEither :: e -> Bool -> Either e () +assertEither e cond = if cond then Right () else Left e + +-- | Data type representing 128-bit keys as 12 English words. Use with +-- functions from Data.Binary. +newtype HumanKey = HumanKey [String] deriving (Eq) + +instance Show HumanKey where + show (HumanKey ws) = concat $ intersperse " " ws + +-- | Build a HumanKey instance. Validates input. +humanKey :: String -> Either String HumanKey +humanKey s = do + let ws = words $ map toUpper s + assertEither "Must have 12 words." $ length ws == 12 + let (ws1, ws2) = splitAt 6 ws + _ <- wordsToKey ws1 + _ <- wordsToKey ws2 + return $ HumanKey ws + +instance Binary HumanKey where + put (HumanKey ws) = do + let (ws1, ws2) = splitAt 6 ws + either fail put $ wordsToKey ws1 + either fail put $ wordsToKey ws2 + + get = do + key1 <- get + key2 <- get + let ws = keyToWords key1 ++ keyToWords key2 + return $ HumanKey $ ws + +keyToWords :: Word64 -> [String] +keyToWords key = + map ((dict !!) . fromIntegral) indices + where + keyCheckSum = checkSum key + tempIndices = map (\start -> extract key start 11) [0,11..55] + indices = init tempIndices ++ [last tempIndices .|. keyCheckSum] + +wordsToKey :: [String] -> Either String Word64 +wordsToKey ws = do + let findWord w = elemIndex w dict >>= return . fromIntegral + maybeIndices = sequence $ map findWord ws + indices <- maybeToEither "Unknown word." maybeIndices + let buildKey acc (bits, index) = (index `shift` bits) .|. acc + key = foldl buildKey 0 $ zip [53,42..(-2)] indices + computedSum = checkSum key + providedSum = last indices .&. 0x03 + assertEither "Checksum failed." $ providedSum == computedSum + return key + +checkSum :: Word64 -> Word64 +checkSum key = + pairSum .&. 0x03 + where + pairSum = sum $ map (flip (extract key) $ 2) [0,2..62] + +extract :: Word64 -> Int -> Int -> Word64 +extract key start len = + temp `shiftL` (len - count) + where + count = if start + len > 64 then 64 - start else len + mask = complement $ 0xffffffffffffffff `shiftL` count + temp = key `shiftR` (64 - start - count) .&. mask + +dict :: [String] +dict = + [ "A", "ABE", "ACE", "ACT", "AD", "ADA", "ADD", "AGO", "AID" + , "AIM", "AIR", "ALL", "ALP", "AM", "AMY", "AN", "ANA", "AND" + , "ANN", "ANT", "ANY", "APE", "APS", "APT", "ARC", "ARE", "ARK" + , "ARM", "ART", "AS", "ASH", "ASK", "AT", "ATE", "AUG", "AUK" + , "AVE", "AWE", "AWK", "AWL", "AWN", "AX", "AYE", "BAD", "BAG" + , "BAH", "BAM", "BAN", "BAR", "BAT", "BAY", "BE", "BED", "BEE" + , "BEG", "BEN", "BET", "BEY", "BIB", "BID", "BIG", "BIN", "BIT" + , "BOB", "BOG", "BON", "BOO", "BOP", "BOW", "BOY", "BUB", "BUD" + , "BUG", "BUM", "BUN", "BUS", "BUT", "BUY", "BY", "BYE", "CAB" + , "CAL", "CAM", "CAN", "CAP", "CAR", "CAT", "CAW", "COD", "COG" + , "COL", "CON", "COO", "COP", "COT", "COW", "COY", "CRY", "CUB" + , "CUE", "CUP", "CUR", "CUT", "DAB", "DAD", "DAM", "DAN", "DAR" + , "DAY", "DEE", "DEL", "DEN", "DES", "DEW", "DID", "DIE", "DIG" + , "DIN", "DIP", "DO", "DOE", "DOG", "DON", "DOT", "DOW", "DRY" + , "DUB", "DUD", "DUE", "DUG", "DUN", "EAR", "EAT", "ED", "EEL" + , "EGG", "EGO", "ELI", "ELK", "ELM", "ELY", "EM", "END", "EST" + , "ETC", "EVA", "EVE", "EWE", "EYE", "FAD", "FAN", "FAR", "FAT" + , "FAY", "FED", "FEE", "FEW", "FIB", "FIG", "FIN", "FIR", "FIT" + , "FLO", "FLY", "FOE", "FOG", "FOR", "FRY", "FUM", "FUN", "FUR" + , "GAB", "GAD", "GAG", "GAL", "GAM", "GAP", "GAS", "GAY", "GEE" + , "GEL", "GEM", "GET", "GIG", "GIL", "GIN", "GO", "GOT", "GUM" + , "GUN", "GUS", "GUT", "GUY", "GYM", "GYP", "HA", "HAD", "HAL" + , "HAM", "HAN", "HAP", "HAS", "HAT", "HAW", "HAY", "HE", "HEM" + , "HEN", "HER", "HEW", "HEY", "HI", "HID", "HIM", "HIP", "HIS" + , "HIT", "HO", "HOB", "HOC", "HOE", "HOG", "HOP", "HOT", "HOW" + , "HUB", "HUE", "HUG", "HUH", "HUM", "HUT", "I", "ICY", "IDA" + , "IF", "IKE", "ILL", "INK", "INN", "IO", "ION", "IQ", "IRA" + , "IRE", "IRK", "IS", "IT", "ITS", "IVY", "JAB", "JAG", "JAM" + , "JAN", "JAR", "JAW", "JAY", "JET", "JIG", "JIM", "JO", "JOB" + , "JOE", "JOG", "JOT", "JOY", "JUG", "JUT", "KAY", "KEG", "KEN" + , "KEY", "KID", "KIM", "KIN", "KIT", "LA", "LAB", "LAC", "LAD" + , "LAG", "LAM", "LAP", "LAW", "LAY", "LEA", "LED", "LEE", "LEG" + , "LEN", "LEO", "LET", "LEW", "LID", "LIE", "LIN", "LIP", "LIT" + , "LO", "LOB", "LOG", "LOP", "LOS", "LOT", "LOU", "LOW", "LOY" + , "LUG", "LYE", "MA", "MAC", "MAD", "MAE", "MAN", "MAO", "MAP" + , "MAT", "MAW", "MAY", "ME", "MEG", "MEL", "MEN", "MET", "MEW" + , "MID", "MIN", "MIT", "MOB", "MOD", "MOE", "MOO", "MOP", "MOS" + , "MOT", "MOW", "MUD", "MUG", "MUM", "MY", "NAB", "NAG", "NAN" + , "NAP", "NAT", "NAY", "NE", "NED", "NEE", "NET", "NEW", "NIB" + , "NIL", "NIP", "NIT", "NO", "NOB", "NOD", "NON", "NOR", "NOT" + , "NOV", "NOW", "NU", "NUN", "NUT", "O", "OAF", "OAK", "OAR" + , "OAT", "ODD", "ODE", "OF", "OFF", "OFT", "OH", "OIL", "OK" + , "OLD", "ON", "ONE", "OR", "ORB", "ORE", "ORR", "OS", "OTT" + , "OUR", "OUT", "OVA", "OW", "OWE", "OWL", "OWN", "OX", "PA" + , "PAD", "PAL", "PAM", "PAN", "PAP", "PAR", "PAT", "PAW", "PAY" + , "PEA", "PEG", "PEN", "PEP", "PER", "PET", "PEW", "PHI", "PI" + , "PIE", "PIN", "PIT", "PLY", "PO", "POD", "POE", "POP", "POT" + , "POW", "PRO", "PRY", "PUB", "PUG", "PUN", "PUP", "PUT", "QUO" + , "RAG", "RAM", "RAN", "RAP", "RAT", "RAW", "RAY", "REB", "RED" + , "REP", "RET", "RIB", "RID", "RIG", "RIM", "RIO", "RIP", "ROB" + , "ROD", "ROE", "RON", "ROT", "ROW", "ROY", "RUB", "RUE", "RUG" + , "RUM", "RUN", "RYE", "SAC", "SAD", "SAG", "SAL", "SAM", "SAN" + , "SAP", "SAT", "SAW", "SAY", "SEA", "SEC", "SEE", "SEN", "SET" + , "SEW", "SHE", "SHY", "SIN", "SIP", "SIR", "SIS", "SIT", "SKI" + , "SKY", "SLY", "SO", "SOB", "SOD", "SON", "SOP", "SOW", "SOY" + , "SPA", "SPY", "SUB", "SUD", "SUE", "SUM", "SUN", "SUP", "TAB" + , "TAD", "TAG", "TAN", "TAP", "TAR", "TEA", "TED", "TEE", "TEN" + , "THE", "THY", "TIC", "TIE", "TIM", "TIN", "TIP", "TO", "TOE" + , "TOG", "TOM", "TON", "TOO", "TOP", "TOW", "TOY", "TRY", "TUB" + , "TUG", "TUM", "TUN", "TWO", "UN", "UP", "US", "USE", "VAN" + , "VAT", "VET", "VIE", "WAD", "WAG", "WAR", "WAS", "WAY", "WE" + , "WEB", "WED", "WEE", "WET", "WHO", "WHY", "WIN", "WIT", "WOK" + , "WON", "WOO", "WOW", "WRY", "WU", "YAM", "YAP", "YAW", "YE" + , "YEA", "YES", "YET", "YOU", "ABED", "ABEL", "ABET", "ABLE", "ABUT" + , "ACHE", "ACID", "ACME", "ACRE", "ACTA", "ACTS", "ADAM", "ADDS", "ADEN" + , "AFAR", "AFRO", "AGEE", "AHEM", "AHOY", "AIDA", "AIDE", "AIDS", "AIRY" + , "AJAR", "AKIN", "ALAN", "ALEC", "ALGA", "ALIA", "ALLY", "ALMA", "ALOE" + , "ALSO", "ALTO", "ALUM", "ALVA", "AMEN", "AMES", "AMID", "AMMO", "AMOK" + , "AMOS", "AMRA", "ANDY", "ANEW", "ANNA", "ANNE", "ANTE", "ANTI", "AQUA" + , "ARAB", "ARCH", "AREA", "ARGO", "ARID", "ARMY", "ARTS", "ARTY", "ASIA" + , "ASKS", "ATOM", "AUNT", "AURA", "AUTO", "AVER", "AVID", "AVIS", "AVON" + , "AVOW", "AWAY", "AWRY", "BABE", "BABY", "BACH", "BACK", "BADE", "BAIL" + , "BAIT", "BAKE", "BALD", "BALE", "BALI", "BALK", "BALL", "BALM", "BAND" + , "BANE", "BANG", "BANK", "BARB", "BARD", "BARE", "BARK", "BARN", "BARR" + , "BASE", "BASH", "BASK", "BASS", "BATE", "BATH", "BAWD", "BAWL", "BEAD" + , "BEAK", "BEAM", "BEAN", "BEAR", "BEAT", "BEAU", "BECK", "BEEF", "BEEN" + , "BEER", "BEET", "BELA", "BELL", "BELT", "BEND", "BENT", "BERG", "BERN" + , "BERT", "BESS", "BEST", "BETA", "BETH", "BHOY", "BIAS", "BIDE", "BIEN" + , "BILE", "BILK", "BILL", "BIND", "BING", "BIRD", "BITE", "BITS", "BLAB" + , "BLAT", "BLED", "BLEW", "BLOB", "BLOC", "BLOT", "BLOW", "BLUE", "BLUM" + , "BLUR", "BOAR", "BOAT", "BOCA", "BOCK", "BODE", "BODY", "BOGY", "BOHR" + , "BOIL", "BOLD", "BOLO", "BOLT", "BOMB", "BONA", "BOND", "BONE", "BONG" + , "BONN", "BONY", "BOOK", "BOOM", "BOON", "BOOT", "BORE", "BORG", "BORN" + , "BOSE", "BOSS", "BOTH", "BOUT", "BOWL", "BOYD", "BRAD", "BRAE", "BRAG" + , "BRAN", "BRAY", "BRED", "BREW", "BRIG", "BRIM", "BROW", "BUCK", "BUDD" + , "BUFF", "BULB", "BULK", "BULL", "BUNK", "BUNT", "BUOY", "BURG", "BURL" + , "BURN", "BURR", "BURT", "BURY", "BUSH", "BUSS", "BUST", "BUSY", "BYTE" + , "CADY", "CAFE", "CAGE", "CAIN", "CAKE", "CALF", "CALL", "CALM", "CAME" + , "CANE", "CANT", "CARD", "CARE", "CARL", "CARR", "CART", "CASE", "CASH" + , "CASK", "CAST", "CAVE", "CEIL", "CELL", "CENT", "CERN", "CHAD", "CHAR" + , "CHAT", "CHAW", "CHEF", "CHEN", "CHEW", "CHIC", "CHIN", "CHOU", "CHOW" + , "CHUB", "CHUG", "CHUM", "CITE", "CITY", "CLAD", "CLAM", "CLAN", "CLAW" + , "CLAY", "CLOD", "CLOG", "CLOT", "CLUB", "CLUE", "COAL", "COAT", "COCA" + , "COCK", "COCO", "CODA", "CODE", "CODY", "COED", "COIL", "COIN", "COKE" + , "COLA", "COLD", "COLT", "COMA", "COMB", "COME", "COOK", "COOL", "COON" + , "COOT", "CORD", "CORE", "CORK", "CORN", "COST", "COVE", "COWL", "CRAB" + , "CRAG", "CRAM", "CRAY", "CREW", "CRIB", "CROW", "CRUD", "CUBA", "CUBE" + , "CUFF", "CULL", "CULT", "CUNY", "CURB", "CURD", "CURE", "CURL", "CURT" + , "CUTS", "DADE", "DALE", "DAME", "DANA", "DANE", "DANG", "DANK", "DARE" + , "DARK", "DARN", "DART", "DASH", "DATA", "DATE", "DAVE", "DAVY", "DAWN" + , "DAYS", "DEAD", "DEAF", "DEAL", "DEAN", "DEAR", "DEBT", "DECK", "DEED" + , "DEEM", "DEER", "DEFT", "DEFY", "DELL", "DENT", "DENY", "DESK", "DIAL" + , "DICE", "DIED", "DIET", "DIME", "DINE", "DING", "DINT", "DIRE", "DIRT" + , "DISC", "DISH", "DISK", "DIVE", "DOCK", "DOES", "DOLE", "DOLL", "DOLT" + , "DOME", "DONE", "DOOM", "DOOR", "DORA", "DOSE", "DOTE", "DOUG", "DOUR" + , "DOVE", "DOWN", "DRAB", "DRAG", "DRAM", "DRAW", "DREW", "DRUB", "DRUG" + , "DRUM", "DUAL", "DUCK", "DUCT", "DUEL", "DUET", "DUKE", "DULL", "DUMB" + , "DUNE", "DUNK", "DUSK", "DUST", "DUTY", "EACH", "EARL", "EARN", "EASE" + , "EAST", "EASY", "EBEN", "ECHO", "EDDY", "EDEN", "EDGE", "EDGY", "EDIT" + , "EDNA", "EGAN", "ELAN", "ELBA", "ELLA", "ELSE", "EMIL", "EMIT", "EMMA" + , "ENDS", "ERIC", "EROS", "EVEN", "EVER", "EVIL", "EYED", "FACE", "FACT" + , "FADE", "FAIL", "FAIN", "FAIR", "FAKE", "FALL", "FAME", "FANG", "FARM" + , "FAST", "FATE", "FAWN", "FEAR", "FEAT", "FEED", "FEEL", "FEET", "FELL" + , "FELT", "FEND", "FERN", "FEST", "FEUD", "FIEF", "FIGS", "FILE", "FILL" + , "FILM", "FIND", "FINE", "FINK", "FIRE", "FIRM", "FISH", "FISK", "FIST" + , "FITS", "FIVE", "FLAG", "FLAK", "FLAM", "FLAT", "FLAW", "FLEA", "FLED" + , "FLEW", "FLIT", "FLOC", "FLOG", "FLOW", "FLUB", "FLUE", "FOAL", "FOAM" + , "FOGY", "FOIL", "FOLD", "FOLK", "FOND", "FONT", "FOOD", "FOOL", "FOOT" + , "FORD", "FORE", "FORK", "FORM", "FORT", "FOSS", "FOUL", "FOUR", "FOWL" + , "FRAU", "FRAY", "FRED", "FREE", "FRET", "FREY", "FROG", "FROM", "FUEL" + , "FULL", "FUME", "FUND", "FUNK", "FURY", "FUSE", "FUSS", "GAFF", "GAGE" + , "GAIL", "GAIN", "GAIT", "GALA", "GALE", "GALL", "GALT", "GAME", "GANG" + , "GARB", "GARY", "GASH", "GATE", "GAUL", "GAUR", "GAVE", "GAWK", "GEAR" + , "GELD", "GENE", "GENT", "GERM", "GETS", "GIBE", "GIFT", "GILD", "GILL" + , "GILT", "GINA", "GIRD", "GIRL", "GIST", "GIVE", "GLAD", "GLEE", "GLEN" + , "GLIB", "GLOB", "GLOM", "GLOW", "GLUE", "GLUM", "GLUT", "GOAD", "GOAL" + , "GOAT", "GOER", "GOES", "GOLD", "GOLF", "GONE", "GONG", "GOOD", "GOOF" + , "GORE", "GORY", "GOSH", "GOUT", "GOWN", "GRAB", "GRAD", "GRAY", "GREG" + , "GREW", "GREY", "GRID", "GRIM", "GRIN", "GRIT", "GROW", "GRUB", "GULF" + , "GULL", "GUNK", "GURU", "GUSH", "GUST", "GWEN", "GWYN", "HAAG", "HAAS" + , "HACK", "HAIL", "HAIR", "HALE", "HALF", "HALL", "HALO", "HALT", "HAND" + , "HANG", "HANK", "HANS", "HARD", "HARK", "HARM", "HART", "HASH", "HAST" + , "HATE", "HATH", "HAUL", "HAVE", "HAWK", "HAYS", "HEAD", "HEAL", "HEAR" + , "HEAT", "HEBE", "HECK", "HEED", "HEEL", "HEFT", "HELD", "HELL", "HELM" + , "HERB", "HERD", "HERE", "HERO", "HERS", "HESS", "HEWN", "HICK", "HIDE" + , "HIGH", "HIKE", "HILL", "HILT", "HIND", "HINT", "HIRE", "HISS", "HIVE" + , "HOBO", "HOCK", "HOFF", "HOLD", "HOLE", "HOLM", "HOLT", "HOME", "HONE" + , "HONK", "HOOD", "HOOF", "HOOK", "HOOT", "HORN", "HOSE", "HOST", "HOUR" + , "HOVE", "HOWE", "HOWL", "HOYT", "HUCK", "HUED", "HUFF", "HUGE", "HUGH" + , "HUGO", "HULK", "HULL", "HUNK", "HUNT", "HURD", "HURL", "HURT", "HUSH" + , "HYDE", "HYMN", "IBIS", "ICON", "IDEA", "IDLE", "IFFY", "INCA", "INCH" + , "INTO", "IONS", "IOTA", "IOWA", "IRIS", "IRMA", "IRON", "ISLE", "ITCH" + , "ITEM", "IVAN", "JACK", "JADE", "JAIL", "JAKE", "JANE", "JAVA", "JEAN" + , "JEFF", "JERK", "JESS", "JEST", "JIBE", "JILL", "JILT", "JIVE", "JOAN" + , "JOBS", "JOCK", "JOEL", "JOEY", "JOHN", "JOIN", "JOKE", "JOLT", "JOVE" + , "JUDD", "JUDE", "JUDO", "JUDY", "JUJU", "JUKE", "JULY", "JUNE", "JUNK" + , "JUNO", "JURY", "JUST", "JUTE", "KAHN", "KALE", "KANE", "KANT", "KARL" + , "KATE", "KEEL", "KEEN", "KENO", "KENT", "KERN", "KERR", "KEYS", "KICK" + , "KILL", "KIND", "KING", "KIRK", "KISS", "KITE", "KLAN", "KNEE", "KNEW" + , "KNIT", "KNOB", "KNOT", "KNOW", "KOCH", "KONG", "KUDO", "KURD", "KURT" + , "KYLE", "LACE", "LACK", "LACY", "LADY", "LAID", "LAIN", "LAIR", "LAKE" + , "LAMB", "LAME", "LAND", "LANE", "LANG", "LARD", "LARK", "LASS", "LAST" + , "LATE", "LAUD", "LAVA", "LAWN", "LAWS", "LAYS", "LEAD", "LEAF", "LEAK" + , "LEAN", "LEAR", "LEEK", "LEER", "LEFT", "LEND", "LENS", "LENT", "LEON" + , "LESK", "LESS", "LEST", "LETS", "LIAR", "LICE", "LICK", "LIED", "LIEN" + , "LIES", "LIEU", "LIFE", "LIFT", "LIKE", "LILA", "LILT", "LILY", "LIMA" + , "LIMB", "LIME", "LIND", "LINE", "LINK", "LINT", "LION", "LISA", "LIST" + , "LIVE", "LOAD", "LOAF", "LOAM", "LOAN", "LOCK", "LOFT", "LOGE", "LOIS" + , "LOLA", "LONE", "LONG", "LOOK", "LOON", "LOOT", "LORD", "LORE", "LOSE" + , "LOSS", "LOST", "LOUD", "LOVE", "LOWE", "LUCK", "LUCY", "LUGE", "LUKE" + , "LULU", "LUND", "LUNG", "LURA", "LURE", "LURK", "LUSH", "LUST", "LYLE" + , "LYNN", "LYON", "LYRA", "MACE", "MADE", "MAGI", "MAID", "MAIL", "MAIN" + , "MAKE", "MALE", "MALI", "MALL", "MALT", "MANA", "MANN", "MANY", "MARC" + , "MARE", "MARK", "MARS", "MART", "MARY", "MASH", "MASK", "MASS", "MAST" + , "MATE", "MATH", "MAUL", "MAYO", "MEAD", "MEAL", "MEAN", "MEAT", "MEEK" + , "MEET", "MELD", "MELT", "MEMO", "MEND", "MENU", "MERT", "MESH", "MESS" + , "MICE", "MIKE", "MILD", "MILE", "MILK", "MILL", "MILT", "MIMI", "MIND" + , "MINE", "MINI", "MINK", "MINT", "MIRE", "MISS", "MIST", "MITE", "MITT" + , "MOAN", "MOAT", "MOCK", "MODE", "MOLD", "MOLE", "MOLL", "MOLT", "MONA" + , "MONK", "MONT", "MOOD", "MOON", "MOOR", "MOOT", "MORE", "MORN", "MORT" + , "MOSS", "MOST", "MOTH", "MOVE", "MUCH", "MUCK", "MUDD", "MUFF", "MULE" + , "MULL", "MURK", "MUSH", "MUST", "MUTE", "MUTT", "MYRA", "MYTH", "NAGY" + , "NAIL", "NAIR", "NAME", "NARY", "NASH", "NAVE", "NAVY", "NEAL", "NEAR" + , "NEAT", "NECK", "NEED", "NEIL", "NELL", "NEON", "NERO", "NESS", "NEST" + , "NEWS", "NEWT", "NIBS", "NICE", "NICK", "NILE", "NINA", "NINE", "NOAH" + , "NODE", "NOEL", "NOLL", "NONE", "NOOK", "NOON", "NORM", "NOSE", "NOTE" + , "NOUN", "NOVA", "NUDE", "NULL", "NUMB", "OATH", "OBEY", "OBOE", "ODIN" + , "OHIO", "OILY", "OINT", "OKAY", "OLAF", "OLDY", "OLGA", "OLIN", "OMAN" + , "OMEN", "OMIT", "ONCE", "ONES", "ONLY", "ONTO", "ONUS", "ORAL", "ORGY" + , "OSLO", "OTIS", "OTTO", "OUCH", "OUST", "OUTS", "OVAL", "OVEN", "OVER" + , "OWLY", "OWNS", "QUAD", "QUIT", "QUOD", "RACE", "RACK", "RACY", "RAFT" + , "RAGE", "RAID", "RAIL", "RAIN", "RAKE", "RANK", "RANT", "RARE", "RASH" + , "RATE", "RAVE", "RAYS", "READ", "REAL", "REAM", "REAR", "RECK", "REED" + , "REEF", "REEK", "REEL", "REID", "REIN", "RENA", "REND", "RENT", "REST" + , "RICE", "RICH", "RICK", "RIDE", "RIFT", "RILL", "RIME", "RING", "RINK" + , "RISE", "RISK", "RITE", "ROAD", "ROAM", "ROAR", "ROBE", "ROCK", "RODE" + , "ROIL", "ROLL", "ROME", "ROOD", "ROOF", "ROOK", "ROOM", "ROOT", "ROSA" + , "ROSE", "ROSS", "ROSY", "ROTH", "ROUT", "ROVE", "ROWE", "ROWS", "RUBE" + , "RUBY", "RUDE", "RUDY", "RUIN", "RULE", "RUNG", "RUNS", "RUNT", "RUSE" + , "RUSH", "RUSK", "RUSS", "RUST", "RUTH", "SACK", "SAFE", "SAGE", "SAID" + , "SAIL", "SALE", "SALK", "SALT", "SAME", "SAND", "SANE", "SANG", "SANK" + , "SARA", "SAUL", "SAVE", "SAYS", "SCAN", "SCAR", "SCAT", "SCOT", "SEAL" + , "SEAM", "SEAR", "SEAT", "SEED", "SEEK", "SEEM", "SEEN", "SEES", "SELF" + , "SELL", "SEND", "SENT", "SETS", "SEWN", "SHAG", "SHAM", "SHAW", "SHAY" + , "SHED", "SHIM", "SHIN", "SHOD", "SHOE", "SHOT", "SHOW", "SHUN", "SHUT" + , "SICK", "SIDE", "SIFT", "SIGH", "SIGN", "SILK", "SILL", "SILO", "SILT" + , "SINE", "SING", "SINK", "SIRE", "SITE", "SITS", "SITU", "SKAT", "SKEW" + , "SKID", "SKIM", "SKIN", "SKIT", "SLAB", "SLAM", "SLAT", "SLAY", "SLED" + , "SLEW", "SLID", "SLIM", "SLIT", "SLOB", "SLOG", "SLOT", "SLOW", "SLUG" + , "SLUM", "SLUR", "SMOG", "SMUG", "SNAG", "SNOB", "SNOW", "SNUB", "SNUG" + , "SOAK", "SOAR", "SOCK", "SODA", "SOFA", "SOFT", "SOIL", "SOLD", "SOME" + , "SONG", "SOON", "SOOT", "SORE", "SORT", "SOUL", "SOUR", "SOWN", "STAB" + , "STAG", "STAN", "STAR", "STAY", "STEM", "STEW", "STIR", "STOW", "STUB" + , "STUN", "SUCH", "SUDS", "SUIT", "SULK", "SUMS", "SUNG", "SUNK", "SURE" + , "SURF", "SWAB", "SWAG", "SWAM", "SWAN", "SWAT", "SWAY", "SWIM", "SWUM" + , "TACK", "TACT", "TAIL", "TAKE", "TALE", "TALK", "TALL", "TANK", "TASK" + , "TATE", "TAUT", "TEAL", "TEAM", "TEAR", "TECH", "TEEM", "TEEN", "TEET" + , "TELL", "TEND", "TENT", "TERM", "TERN", "TESS", "TEST", "THAN", "THAT" + , "THEE", "THEM", "THEN", "THEY", "THIN", "THIS", "THUD", "THUG", "TICK" + , "TIDE", "TIDY", "TIED", "TIER", "TILE", "TILL", "TILT", "TIME", "TINA" + , "TINE", "TINT", "TINY", "TIRE", "TOAD", "TOGO", "TOIL", "TOLD", "TOLL" + , "TONE", "TONG", "TONY", "TOOK", "TOOL", "TOOT", "TORE", "TORN", "TOTE" + , "TOUR", "TOUT", "TOWN", "TRAG", "TRAM", "TRAY", "TREE", "TREK", "TRIG" + , "TRIM", "TRIO", "TROD", "TROT", "TROY", "TRUE", "TUBA", "TUBE", "TUCK" + , "TUFT", "TUNA", "TUNE", "TUNG", "TURF", "TURN", "TUSK", "TWIG", "TWIN" + , "TWIT", "ULAN", "UNIT", "URGE", "USED", "USER", "USES", "UTAH", "VAIL" + , "VAIN", "VALE", "VARY", "VASE", "VAST", "VEAL", "VEDA", "VEIL", "VEIN" + , "VEND", "VENT", "VERB", "VERY", "VETO", "VICE", "VIEW", "VINE", "VISE" + , "VOID", "VOLT", "VOTE", "WACK", "WADE", "WAGE", "WAIL", "WAIT", "WAKE" + , "WALE", "WALK", "WALL", "WALT", "WAND", "WANE", "WANG", "WANT", "WARD" + , "WARM", "WARN", "WART", "WASH", "WAST", "WATS", "WATT", "WAVE", "WAVY" + , "WAYS", "WEAK", "WEAL", "WEAN", "WEAR", "WEED", "WEEK", "WEIR", "WELD" + , "WELL", "WELT", "WENT", "WERE", "WERT", "WEST", "WHAM", "WHAT", "WHEE" + , "WHEN", "WHET", "WHOA", "WHOM", "WICK", "WIFE", "WILD", "WILL", "WIND" + , "WINE", "WING", "WINK", "WINO", "WIRE", "WISE", "WISH", "WITH", "WOLF" + , "WONT", "WOOD", "WOOL", "WORD", "WORE", "WORK", "WORM", "WORN", "WOVE" + , "WRIT", "WYNN", "YALE", "YANG", "YANK", "YARD", "YARN", "YAWL", "YAWN" + , "YEAH", "YEAR", "YELL", "YOGA", "YOKE" + ] diff --git a/RFC1751.cabal b/RFC1751.cabal new file mode 100644 --- /dev/null +++ b/RFC1751.cabal @@ -0,0 +1,42 @@ +-- Initial RFC1751.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: RFC1751 +version: 0.1.0.0 +synopsis: RFC-1751 library for Haskell +description: Convert 128-bit ByteString to/from 12 English words. +homepage: https://github.com/Xeno-Genesis/RFC1751 +license: PublicDomain +license-file: UNLICENSE +author: Jean-Pierre Rupp +maintainer: root@xeno-genesis.com +-- copyright: +category: Data +build-type: Simple +cabal-version: >=1.8 + +source-repository head + type: git + location: git@github.com:Xeno-Genesis/RFC1751.git + +library + exposed-modules: Data.RFC1751 + build-depends: base >=4.6 && <4.7, + binary + +test-suite test-haskoin-crypto + type: exitcode-stdio-1.0 + main-is: Main.hs + other-modules: Tests, + Units + build-depends: base, + binary, + bytestring, + RFC1751, + QuickCheck, + test-framework, + test-framework-quickcheck2, + test-framework-hunit, + HUnit + hs-source-dirs: . tests + ghc-options: -Wall diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/UNLICENSE b/UNLICENSE new file mode 100644 --- /dev/null +++ b/UNLICENSE @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to diff --git a/tests/Main.hs b/tests/Main.hs new file mode 100644 --- /dev/null +++ b/tests/Main.hs @@ -0,0 +1,12 @@ +module Main where + +import Test.Framework (defaultMain) + +-- Property testing +import qualified Tests (tests) + +-- Unit testing +import qualified Units (tests) + +main :: IO () +main = defaultMain (Tests.tests ++ Units.tests) diff --git a/tests/Tests.hs b/tests/Tests.hs new file mode 100644 --- /dev/null +++ b/tests/Tests.hs @@ -0,0 +1,46 @@ +module Tests (tests) where + +import Data.Char +import Data.Binary +import qualified Data.ByteString.Lazy.Char8 as C +import Data.RFC1751 +import Test.Framework +import Test.Framework.Providers.QuickCheck2 + +tests :: [Test] +tests = + [ testGroup "RFC-1751" + [ testProperty "Encode/Decode RFC-1751 keys" decodeEncode + , testProperty "Encode/Decode RFC-1751 keys (lowercase)" decodeEncodeLc + , testProperty "Double 64-bit key" doubleWord64 + ] + ] + +fromRight :: Either a b -> b +fromRight (Right b) = b +fromRight _ = error "Either.fromRight: Left" + +decodeEncode :: (Word64, Word64) -> Bool +decodeEncode (w1, w2) = + bs == bs' + where + bs = encode w1 `C.append` encode w2 + hk = decode bs :: HumanKey + bs' = encode hk + +decodeEncodeLc :: (Word64, Word64) -> Bool +decodeEncodeLc (w1, w2) = + bs == bs' + where + bs = encode w1 `C.append` encode w2 + hk = decode bs :: HumanKey + hk' = fromRight . humanKey . map toLower $ show hk + bs' = encode hk' + +doubleWord64 :: Word64 -> Bool +doubleWord64 w = + ws1 == ws2 + where + bs = encode w `C.append` encode w + hk = decode bs :: HumanKey + (ws1, ws2) = splitAt 6 $ words $ show hk diff --git a/tests/Units.hs b/tests/Units.hs new file mode 100644 --- /dev/null +++ b/tests/Units.hs @@ -0,0 +1,137 @@ +module Units (tests) where + +import Control.Monad +import qualified Data.ByteString.Lazy as B +import qualified Data.ByteString.Lazy.Char8 as C +import Data.Binary +import Data.Bits +import Data.List +import Numeric + +import Test.HUnit ((@=?)) +import Test.Framework (Test, testGroup) +import Test.Framework.Providers.HUnit (testCase) + +import Data.Maybe + +import Data.RFC1751 + +tests :: [Test] +tests = + [ testGroup "RFC-1751 unit tests" + [ testGroup "Encode keys in RFC-1751" + . map encodeTest $ zip [1..] vectors + , testGroup "Decode keys in RFC-1751" + . map decodeTest $ zip [1..] vectors + , testGroup "Encode keys in RFC-1751 (lowercase)" + . map encodeTest $ zip [1..] vectorsLc + , testGroup "Decode keys in RFC-1751 (lowercase)" + . map decodeTest $ zip [1..] vectorsLc + , testGroup "Bad checksums" + . map badChecksum $ zip [1..] badChecksumVectors + , testGroup "Bad checksums (lowercase)" + . map badChecksum $ zip [1..] badChecksumVectorsLc + , testGroup "Not in dictionary" + . map notDict $ zip [1..] notDictVectors + , testGroup "Not in dictionary (lowercase)" + . map notDict $ zip [1..] notDictVectorsLc + ] + ] + +type TestVector = (C.ByteString, HumanKey) + +badChecksumVectors :: [String] +badChecksumVectors = + [ "RASH BUSH MILK LOOK BAD A AVID GAFF BAIT ROT POD LOVE" + , "TAB BORE DUNK SURE COVE NORM PRY IF JOE MYRA GWEN TENT" + , "BORN ROLL LOVE BEAR AGEE IFFY CUTS MASK MOOD FOWL ROME MIT" + ] + +badChecksumVectorsLc :: [String] +badChecksumVectorsLc = + [ "rash bush milk look bad a avid gaff bait rot pod love" + , "tab bore dunk sure cove norm pry if joe myra gwen tent" + , "born roll love bear agee iffy cuts mask mood fowl rome mit" + ] + +badChecksum :: (Int, String) -> Test +badChecksum (i, s) = testCase ("Bad checksum #" ++ show i) + (Left "Checksum failed." @=? humanKey s) + +notDictVectors :: [String] +notDictVectors = + [ "PHON MEMO HOP NELL RET DEAF HURT YAWN FLAG MILE LEO LESK" + , "JAG SUCH PER HASH FULL PHON DAN THEY CAIN BOND LEFT COCA" + , "TENT TIER LIEU ROD URGE BOWL PATK HOOK FLEW ELY MAN OAK" + , "TIE OLDY FEEL DOCK EWE PA EMIT HAVE HIS TOTE SWAN KTUH" + ] + +notDictVectorsLc :: [String] +notDictVectorsLc = + [ "phon memo hop nell ret deaf hurt yawn flag mile leo lesk" + , "jag such per hash full phon dan they cain bond left coca" + , "tent tier lieu rod urge bowl patk hook flew ely man oak" + , "tie oldy feel dock ewe pa emit have his tote swan ktuh" + ] + +notDict :: (Int, String) -> Test +notDict (i, s) = testCase ("Not in dictionary #" ++ show i) + (Left "Unknown word." @=? humanKey s) + +fromRight :: Either a b -> b +fromRight (Right b) = b +fromRight _ = error "Either.fromRight: Left" + +integerToBS :: Integer -> C.ByteString +integerToBS 0 = B.pack [0] +integerToBS i + | i > 0 = B.pack $ reverse $ unfoldr f i + | otherwise = error "integerToBS not defined for negative values" + where + f 0 = Nothing + f x = Just $ (fromInteger x :: Word8, x `shiftR` 8) + +hexToBS :: String -> Maybe C.ByteString +hexToBS str + | null str = Just C.empty + | otherwise = liftM2 C.append (Just z2) r2 + where + (z,r) = span (== '0') str + z2 = B.replicate (fromIntegral $ length z `div` 2) 0 + r1 = readHex r + r2 | null r = Just C.empty + | null r1 = Nothing + | otherwise = Just $ integerToBS $ fst $ head r1 + +hex2lbs :: String -> C.ByteString +hex2lbs = fromJust . hexToBS . filter (/=' ') + +vectors :: [TestVector] +vectors = + [ ( hex2lbs "CCAC 2AED 5910 56BE 4F90 FD44 1C53 4766" + , fromRight $ + humanKey "RASH BUSH MILK LOOK BAD BRIM AVID GAFF BAIT ROT POD LOVE" + ) + , ( hex2lbs "EFF8 1F9B FBC6 5350 920C DD74 16DE 8009" + , fromRight $ + humanKey "TROD MUTE TAIL WARM CHAR KONG HAAG CITY BORE O TEAL AWL" + ) + ] + +vectorsLc :: [TestVector] +vectorsLc = + [ ( hex2lbs "ccac 2aed 5910 56be 4f90 fd44 1c53 4766" + , fromRight $ + humanKey "rash bush milk look bad brim avid gaff bait rot pod love" + ) + , ( hex2lbs "eff8 1f9b fbc6 5350 920c dd74 16de 8009" + , fromRight $ + humanKey "trod mute tail warm char kong haag city bore o teal awl" + ) + ] + +encodeTest :: (Int, TestVector) -> Test +encodeTest (i, (bs, hk)) = testCase ("Encode #" ++ show i) (bs @=? encode hk) + +decodeTest :: (Int, TestVector) -> Test +decodeTest (i, (bs, hk)) = testCase ("Decode #" ++ show i) (hk @=? decode bs)