yubikey 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Jonathan Rudenberg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.rdoc

@@ -0,0 +1,33 @@
+= yubikey
+
+== Description
+
+A library to decode, decrypt and parse Yubikey[http://www.yubico.com/home/index/] one-time passwords.
+
+== Usage
+    
+  key = 'ecde18dbe76fbd0c33330f1c354871db'
+  otp = 'dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh'
+  token = Yubikey::OTP.new(otp, key)
+  
+  p "Device public id: #{token.public_id}" #=> 'dteffuje'
+  p "Device secret id: #{token.secret_id}" #=> '8792ebfe26cc'
+  p "Device insertions: #{token.insert_counter}" #=> 19
+  p "Session activation counter: #{token.session_counter}" #=> 17
+  p "Session timestamp: #{token.timestamp}" #=> 49712
+  p "OTP random data: #{token.random_number}" #=> 40904
+  
+== Install
+
+  sudo gem install yubikey
+
+== Copyright
+
+=== Ruby library
+  Written by Jonathan Rudenberg <jon335@gmail.com>
+  Copyright (c) 2009 Jonathan Rudenberg
+  The MIT License. See LICENSE.
+
+=== AES, ModHex, and CRC code
+  Written by Simon Josefsson <simon@josefsson.org>
+  Copyright (c) 2006, 2007, 2008, 2009 Yubico AB

data/examples/otp.rb

@@ -0,0 +1,12 @@
+require 'yubikey'
+
+key = 'ecde18dbe76fbd0c33330f1c354871db'
+otp = 'dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh'
+token = Yubikey::OTP.new(otp, key)
+
+p "Device public id: #{token.public_id}"
+p "Device secret id: #{token.secret_id}"
+p "Device insertions: #{token.insert_counter}"
+p "Session activation counter: #{token.session_counter}"
+p "Session timestamp: #{token.timestamp}"
+p "OTP random data: #{token.random_number}"

data/ext/yubikey_ext/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+dir_config('yubikey_ext')
+
+have_header('yubikey.h')
+
+create_makefile('yubikey_ext')

data/ext/yubikey_ext/ykaes.c

@@ -0,0 +1,214 @@
+/* ykaes.c --- Implementation of AES-128.
+ *
+ * Copyright (c) 2006, 2007, 2008, 2009 Yubico AB
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
+ * OWNER OR 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.
+ *
+ */
+
+#include "yubikey.h"
+
+#define	NUMBER_OF_ROUNDS	10
+
+static const uint8_t RC[] =
+  { 0x1, 0x2, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80, 0x1B, 0x36 };
+
+static const uint8_t rijndael_sbox[] = {
+  0x63, 0x7C, 0x77, 0x7B, 0xF2, 0x6B, 0x6F, 0xC5,
+  0x30, 0x01, 0x67, 0x2B, 0xFE, 0xD7, 0xAB, 0x76,
+  0xCA, 0x82, 0xC9, 0x7D, 0xFA, 0x59, 0x47, 0xF0,
+  0xAD, 0xD4, 0xA2, 0xAF, 0x9C, 0xA4, 0x72, 0xC0,
+  0xB7, 0xFD, 0x93, 0x26, 0x36, 0x3F, 0xF7, 0xCC,
+  0x34, 0xA5, 0xE5, 0xF1, 0x71, 0xD8, 0x31, 0x15,
+  0x04, 0xC7, 0x23, 0xC3, 0x18, 0x96, 0x05, 0x9A,
+  0x07, 0x12, 0x80, 0xE2, 0xEB, 0x27, 0xB2, 0x75,
+  0x09, 0x83, 0x2C, 0x1A, 0x1B, 0x6E, 0x5A, 0xA0,
+  0x52, 0x3B, 0xD6, 0xB3, 0x29, 0xE3, 0x2F, 0x84,
+  0x53, 0xD1, 0x00, 0xED, 0x20, 0xFC, 0xB1, 0x5B,
+  0x6A, 0xCB, 0xBE, 0x39, 0x4A, 0x4C, 0x58, 0xCF,
+  0xD0, 0xEF, 0xAA, 0xFB, 0x43, 0x4D, 0x33, 0x85,
+  0x45, 0xF9, 0x02, 0x7F, 0x50, 0x3C, 0x9F, 0xA8,
+  0x51, 0xA3, 0x40, 0x8F, 0x92, 0x9D, 0x38, 0xF5,
+  0xBC, 0xB6, 0xDA, 0x21, 0x10, 0xFF, 0xF3, 0xD2,
+  0xCD, 0x0C, 0x13, 0xEC, 0x5F, 0x97, 0x44, 0x17,
+  0xC4, 0xA7, 0x7E, 0x3D, 0x64, 0x5D, 0x19, 0x73,
+  0x60, 0x81, 0x4F, 0xDC, 0x22, 0x2A, 0x90, 0x88,
+  0x46, 0xEE, 0xB8, 0x14, 0xDE, 0x5E, 0x0B, 0xDB,
+  0xE0, 0x32, 0x3A, 0x0A, 0x49, 0x06, 0x24, 0x5C,
+  0xC2, 0xD3, 0xAC, 0x62, 0x91, 0x95, 0xE4, 0x79,
+  0xE7, 0xC8, 0x37, 0x6D, 0x8D, 0xD5, 0x4E, 0xA9,
+  0x6C, 0x56, 0xF4, 0xEA, 0x65, 0x7A, 0xAE, 0x08,
+  0xBA, 0x78, 0x25, 0x2E, 0x1C, 0xA6, 0xB4, 0xC6,
+  0xE8, 0xDD, 0x74, 0x1F, 0x4B, 0xBD, 0x8B, 0x8A,
+  0x70, 0x3E, 0xB5, 0x66, 0x48, 0x03, 0xF6, 0x0E,
+  0x61, 0x35, 0x57, 0xB9, 0x86, 0xC1, 0x1D, 0x9E,
+  0xE1, 0xF8, 0x98, 0x11, 0x69, 0xD9, 0x8E, 0x94,
+  0x9B, 0x1E, 0x87, 0xE9, 0xCE, 0x55, 0x28, 0xDF,
+  0x8C, 0xA1, 0x89, 0x0D, 0xBF, 0xE6, 0x42, 0x68,
+  0x41, 0x99, 0x2D, 0x0F, 0xB0, 0x54, 0xBB, 0x16
+};
+
+static const uint8_t rijndael_inv_sbox[] = {
+  0x52, 0x09, 0x6A, 0xD5, 0x30, 0x36, 0xA5, 0x38,
+  0xBF, 0x40, 0xA3, 0x9E, 0x81, 0xF3, 0xD7, 0xFB,
+  0x7C, 0xE3, 0x39, 0x82, 0x9B, 0x2F, 0xFF, 0x87,
+  0x34, 0x8E, 0x43, 0x44, 0xC4, 0xDE, 0xE9, 0xCB,
+  0x54, 0x7B, 0x94, 0x32, 0xA6, 0xC2, 0x23, 0x3D,
+  0xEE, 0x4C, 0x95, 0x0B, 0x42, 0xFA, 0xC3, 0x4E,
+  0x08, 0x2E, 0xA1, 0x66, 0x28, 0xD9, 0x24, 0xB2,
+  0x76, 0x5B, 0xA2, 0x49, 0x6D, 0x8B, 0xD1, 0x25,
+  0x72, 0xF8, 0xF6, 0x64, 0x86, 0x68, 0x98, 0x16,
+  0xD4, 0xA4, 0x5C, 0xCC, 0x5D, 0x65, 0xB6, 0x92,
+  0x6C, 0x70, 0x48, 0x50, 0xFD, 0xED, 0xB9, 0xDA,
+  0x5E, 0x15, 0x46, 0x57, 0xA7, 0x8D, 0x9D, 0x84,
+  0x90, 0xD8, 0xAB, 0x00, 0x8C, 0xBC, 0xD3, 0x0A,
+  0xF7, 0xE4, 0x58, 0x05, 0xB8, 0xB3, 0x45, 0x06,
+  0xD0, 0x2C, 0x1E, 0x8F, 0xCA, 0x3F, 0x0F, 0x02,
+  0xC1, 0xAF, 0xBD, 0x03, 0x01, 0x13, 0x8A, 0x6B,
+  0x3A, 0x91, 0x11, 0x41, 0x4F, 0x67, 0xDC, 0xEA,
+  0x97, 0xF2, 0xCF, 0xCE, 0xF0, 0xB4, 0xE6, 0x73,
+  0x96, 0xAC, 0x74, 0x22, 0xE7, 0xAD, 0x35, 0x85,
+  0xE2, 0xF9, 0x37, 0xE8, 0x1C, 0x75, 0xDF, 0x6E,
+  0x47, 0xF1, 0x1A, 0x71, 0x1D, 0x29, 0xC5, 0x89,
+  0x6F, 0xB7, 0x62, 0x0E, 0xAA, 0x18, 0xBE, 0x1B,
+  0xFC, 0x56, 0x3E, 0x4B, 0xC6, 0xD2, 0x79, 0x20,
+  0x9A, 0xDB, 0xC0, 0xFE, 0x78, 0xCD, 0x5A, 0xF4,
+  0x1F, 0xDD, 0xA8, 0x33, 0x88, 0x07, 0xC7, 0x31,
+  0xB1, 0x12, 0x10, 0x59, 0x27, 0x80, 0xEC, 0x5F,
+  0x60, 0x51, 0x7F, 0xA9, 0x19, 0xB5, 0x4A, 0x0D,
+  0x2D, 0xE5, 0x7A, 0x9F, 0x93, 0xC9, 0x9C, 0xEF,
+  0xA0, 0xE0, 0x3B, 0x4D, 0xAE, 0x2A, 0xF5, 0xB0,
+  0xC8, 0xEB, 0xBB, 0x3C, 0x83, 0x53, 0x99, 0x61,
+  0x17, 0x2B, 0x04, 0x7E, 0xBA, 0x77, 0xD6, 0x26,
+  0xE1, 0x69, 0x14, 0x63, 0x55, 0x21, 0x0C, 0x7D
+};
+
+static inline uint8_t
+xtime (uint8_t b)
+{
+  return (b & 0x80) ? ((b << 1) ^ 0x1b) : (b << 1);
+}
+
+void
+yubikey_aes_decrypt (uint8_t * state, const uint8_t * key)
+{
+  uint8_t i, j, round_key[0x10];
+  uint8_t a02x, a13x;
+  uint8_t a02xx, a13xx;
+  uint8_t k1, k2;
+
+  memcpy (round_key, key, sizeof (round_key));
+  for (i = 0; i < NUMBER_OF_ROUNDS; i++)
+    {
+      round_key[0] ^= RC[i];
+
+      round_key[0] ^= rijndael_sbox[round_key[13]];
+      round_key[1] ^= rijndael_sbox[round_key[14]];
+      round_key[2] ^= rijndael_sbox[round_key[15]];
+      round_key[3] ^= rijndael_sbox[round_key[12]];
+
+      for (j = 4; j < 16; j++)
+	round_key[j] ^= round_key[j - 4];
+    }
+  for (i = 0; i < 0x10; i++)
+    state[i] ^= round_key[i];
+
+  for (i = 1; i <= NUMBER_OF_ROUNDS; i++)
+    {
+      // inv_byte_sub_shift_row();
+
+      /* First row: 0 shift, 0 4 8 12 */
+      state[0] = rijndael_inv_sbox[state[0]];
+      state[4] = rijndael_inv_sbox[state[4]];
+      state[8] = rijndael_inv_sbox[state[8]];
+      state[12] = rijndael_inv_sbox[state[12]];
+
+      /* Second row: -1 shift, 1 5 9 13 */
+      j = state[13];
+      state[13] = rijndael_inv_sbox[state[9]];
+      state[9] = rijndael_inv_sbox[state[5]];
+      state[5] = rijndael_inv_sbox[state[1]];
+      state[1] = rijndael_inv_sbox[j];
+
+      /* Third row: -2 shift, 2 6 10 14 */
+      j = state[2];
+      state[2] = rijndael_inv_sbox[state[10]];
+      state[10] = rijndael_inv_sbox[j];
+      j = state[6];
+      state[6] = rijndael_inv_sbox[state[14]];
+      state[14] = rijndael_inv_sbox[j];
+
+      /* Fourth row: -3 shift, 3 7 11 15 */
+      j = state[3];
+      state[3] = rijndael_inv_sbox[state[7]];
+      state[7] = rijndael_inv_sbox[state[11]];
+      state[11] = rijndael_inv_sbox[state[15]];
+      state[15] = rijndael_inv_sbox[j];
+
+//              get_inv_round_key(i);
+
+      for (j = 15; j > 3; j--)
+	round_key[j] ^= round_key[j - 4];
+
+      round_key[0] ^=
+	(RC[NUMBER_OF_ROUNDS - i] ^ rijndael_sbox[round_key[13]]);
+
+      round_key[1] ^= rijndael_sbox[round_key[14]];
+      round_key[2] ^= rijndael_sbox[round_key[15]];
+      round_key[3] ^= rijndael_sbox[round_key[12]];
+
+      for (j = 0; j < 16; j++)
+	state[j] ^= round_key[j];
+      if (i != NUMBER_OF_ROUNDS)
+	{
+
+	  //inv_mix_column();
+
+	  for (j = 0; j < 16; j += 4)
+	    {
+	      k1 = state[j] ^ state[j + 2];
+	      a02x = xtime (k1);
+	      k2 = state[j + 1] ^ state[j + 3];
+	      a13x = xtime (k2);
+
+	      k1 ^= (k2 ^ xtime (state[j + 1] ^ state[j + 2]));
+	      k2 = k1;
+
+	      a02xx = xtime (a02x);
+	      a13xx = xtime (a13x);
+
+	      k1 ^= (xtime (a02xx ^ a13xx) ^ a02xx);
+	      k2 ^= (xtime (a02xx ^ a13xx) ^ a13xx);
+
+	      state[j] ^= (k1 ^ a02x);
+	      state[j + 1] ^= k2;
+	      state[j + 2] ^= (k1 ^ a13x);
+	      state[j + 3] ^= (k2 ^ a02x ^ a13x);
+	    }
+	}
+
+    }
+}

data/ext/yubikey_ext/ykcrc.c

@@ -0,0 +1,54 @@
+/* ykcrc.c --- Implementation of Yubikey CRC-16 function.
+ *
+ * Written by Simon Josefsson <simon@josefsson.org>.
+ * Copyright (c) 2006, 2007, 2008, 2009 Yubico AB
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
+ * OWNER OR 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.
+ *
+ */
+
+#include "yubikey.h"
+
+uint16_t
+yubikey_crc16 (const uint8_t *buf, size_t buf_size)
+{
+  uint16_t m_crc = 0xffff;
+
+  while (buf_size--)
+    {
+      int i, j;
+      m_crc ^= (uint8_t) * buf++ & 0xFF;
+      for (i = 0; i < 8; i++)
+	{
+	  j = m_crc & 1;
+	  m_crc >>= 1;
+	  if (j)
+	    m_crc ^= 0x8408;
+	}
+    }
+
+  return m_crc;
+}

data/ext/yubikey_ext/ykmodhex.c

@@ -0,0 +1,76 @@
+/* ykmodhex.c --- Implementation of modhex encoding/decoding
+ *
+ * Written by Simon Josefsson <simon@josefsson.org>.
+ * Copyright (c) 2006, 2007, 2008, 2009 Yubico AB
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
+ * OWNER OR 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.
+ *
+ */
+
+#include "yubikey.h"
+
+#include <stdbool.h>
+
+static const char trans[] = YUBIKEY_MODHEX_MAP;
+
+void
+yubikey_modhex_encode (char *dst, const char *src, size_t srcSize)
+{
+  while (srcSize--)
+    {
+      *dst++ = trans[(*src >> 4) & 0xf];
+      *dst++ = trans[*src++ & 0xf];
+    }
+
+  *dst = '\0';
+}
+
+void
+yubikey_modhex_decode (char *dst, const char *src, size_t dstSize)
+{
+  char b;
+  bool flag = false;
+  char *p1;
+
+  for (; *src && dstSize > 0; src++)
+    {
+      if ((p1 = strchr (trans, *src)) == NULL)
+	b = 0;
+      else
+	b = (char) (p1 - trans);
+
+      if ((flag = !flag))
+	*dst = b;
+      else
+	{
+	  *dst = (*dst << 4) | b;
+	  dst++;
+	  dstSize--;
+	}
+    }
+  while (dstSize--)
+    *dst++ = 0;
+}

data/ext/yubikey_ext/yubikey.h

@@ -0,0 +1,75 @@
+/* yubikey.h --- Prototypes for low-level Yubikey OTP functions.
+ *
+ * Written by Simon Josefsson <simon@josefsson.org>.
+ * Copyright (c) 2006, 2007, 2008, 2009 Yubico AB
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
+ * OWNER OR 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.
+ *
+ */
+
+#ifndef YUBIKEY_H
+#define YUBIKEY_H
+
+#include <stdint.h>
+#include <string.h>
+
+#define YUBIKEY_BLOCK_SIZE 16
+#define YUBIKEY_KEY_SIZE 16
+#define YUBIKEY_UID_SIZE 6
+
+#define	YUBIKEY_CRC_OK_RESIDUE 0xf0b8
+
+#define yubikey_crc_ok_p(tok) (yubikey_crc16 ((tok), YUBIKEY_BLOCK_SIZE) == YUBIKEY_CRC_OK_RESIDUE)
+
+/*
+ * Low-level functions; ModHex.
+ */
+
+#define YUBIKEY_MODHEX_MAP "cbdefghijklnrtuv"
+
+/* ModHex encode input string SRC of length SRCSIZE and put the zero
+   terminated output string in DST.  The size of the output string DST
+   must be at least 2*SRCSIZE+1.  The output string is always
+   2*SRCSIZE large plus the terminating zero.  */
+extern void yubikey_modhex_encode(char *dst, const char *src, size_t srcsize);
+
+/* ModHex decode input string SRC of length DSTSIZE/2 into output
+   string DST.  The output string DST is always DSTSIZE/2 large plus
+   the terminating zero.  */
+extern void yubikey_modhex_decode(char *dst, const char *src, size_t dstsize);
+
+/* Low-level functions; AES. */
+
+/* AES-decrypt one 16-byte block STATE using the 128-bit KEY, leaving
+   the decrypted output in the STATE buffer. */
+void yubikey_aes_decrypt(uint8_t *state, const uint8_t *key);
+
+/*
+ * Low-level functions; CRC.
+ */
+uint16_t yubikey_crc16 (const uint8_t *buf, size_t buf_size);
+
+#endif

data/ext/yubikey_ext/yubikey_ext.c

@@ -0,0 +1,76 @@
+#include "ruby.h"
+#include "yubikey.h"
+
+/*
+ * call-seq:
+ *   decode(modhex_string) -> string
+ *
+ * Decode a ModHex string into binary data
+ */
+static VALUE
+modhex_decode(VALUE self, VALUE modhex_string) {
+  char* modhex_string_ptr = StringValuePtr(modhex_string);
+  size_t modhex_string_size = strlen(modhex_string_ptr);
+  size_t decoded_string_size = modhex_string_size/2;
+  char* decoded_string;
+  
+   if (modhex_string_size % 2 != 0)
+     rb_raise(rb_eArgError, "ModHex string length is not even");
+  
+  yubikey_modhex_decode(decoded_string, modhex_string_ptr, modhex_string_size);
+  
+  return rb_str_new(decoded_string, decoded_string_size);
+}
+
+/*
+ * call-seq:
+ *   decrypt(state, key) -> plaintext
+ *
+ * Decrypt 16 bytes of binary AES ciphertext to binary plaintext with the Yubico implementation of AES-128 ECB
+ * 
+ * [+state+] 16 bytes of binary ciphertext
+ * [+key+] 16-byte binary key
+ *
+ */
+static VALUE
+aes_decrypt(VALUE self, VALUE state, VALUE key) {
+  char* state_ptr = StringValuePtr(state);
+  char* key_ptr = StringValuePtr(key);
+  
+  if (RSTRING(state)->len != YUBIKEY_BLOCK_SIZE || RSTRING(key)->len != YUBIKEY_KEY_SIZE)
+    rb_raise(rb_eArgError, "key and state must be 16 bytes");
+  
+  yubikey_aes_decrypt((uint8_t*)state_ptr, (uint8_t*)key_ptr);
+  
+  return rb_str_new(state_ptr, YUBIKEY_BLOCK_SIZE);
+}
+
+/*
+ * call-seq:
+ *   valid?(token)
+ *
+ * Check the CRC of a decrypted Yubikey OTP
+ *
+ * [+token+] 16-byte binary token
+ */
+static VALUE
+crc_check(VALUE self, VALUE token) {
+  char* token_ptr = StringValuePtr(token);
+  
+  if (RSTRING(token)->len != YUBIKEY_BLOCK_SIZE)
+    rb_raise(rb_eArgError, "token must be 16 bytes");
+  
+  return yubikey_crc_ok_p((uint8_t*)token_ptr) ? Qtrue : Qfalse;
+}
+
+void
+Init_yubikey_ext() {
+  VALUE rb_mYubikey = rb_define_module("Yubikey");
+  VALUE rb_mYubikeyAES = rb_define_module_under(rb_mYubikey, "AES");
+  VALUE rb_mYubikeyModHex = rb_define_module_under(rb_mYubikey, "ModHex");
+  VALUE rb_mYubikeyCRC = rb_define_module_under(rb_mYubikey, "CRC");
+  
+  rb_define_module_function(rb_mYubikeyModHex, "decode", modhex_decode, 1);
+  rb_define_module_function(rb_mYubikeyAES, "decrypt", aes_decrypt, 2);
+  rb_define_module_function(rb_mYubikeyCRC, "valid?", crc_check, 1);
+}

data/lib/yubikey/hex.rb

@@ -0,0 +1,23 @@
+class String
+  
+  # Convert hex string to binary
+  def to_bin
+    to_a.pack('H*')
+  end
+  
+  # Convert binary string to hex
+  def to_hex
+    unpack('H*')[0]
+  end
+  
+  # Check if the string is hex encoded
+  def hex?
+    self =~ /^[0-9a-fA-F]+$/ ? true : false
+  end
+  
+  # Check if the string is modhex encoded
+  def modhex?
+    self =~ /^[cbdefghijklnrtuv]+$/ ? true : false
+  end
+  
+end

data/lib/yubikey/otp.rb

@@ -0,0 +1,57 @@
+class Yubikey::OTP
+  # first few modhex encoded characters of the OTP
+  attr_reader :public_id
+  # decrypted binary token
+  attr_reader :token
+  # binary AES key
+  attr_reader :aes_key
+  # hex id (encrypted in OTP)
+  attr_reader :secret_id
+  # integer that increments each time the Yubikey is plugged in
+  attr_reader :insert_counter
+  # ~8hz timer, reset on every insert
+  attr_reader :timestamp
+  # activation counter, reset on every insert
+  attr_reader :session_counter
+  # random integer used as padding and extra random noise
+  attr_reader :random_number
+  
+  
+  # Decode/decrypt a Yubikey one-time password
+  #
+  # [+otp+] ModHex encoded Yubikey OTP (at least 32 characters)
+  # [+key+] 32-character hex AES key
+  def initialize(otp, key)    
+    raise InvalidOTPError, 'OTP must be  at least 32 characters of modhex' unless otp.modhex? && otp.length >= 32
+    raise InvalidKeyError, 'Key must be 32 hex characters' unless key.hex? && key.length == 32
+    
+    @public_id = otp[0,otp.length-32] if otp.length > 32
+    
+    @token = Yubikey::ModHex.decode(otp[-32,32])
+    @aes_key = key.to_bin
+    
+    decrypt
+    parse
+  end
+  
+  private
+  
+  def decrypt
+    @token = Yubikey::AES.decrypt(@token, @aes_key)
+  end
+  
+  def parse
+    raise BadCRCError unless Yubikey::CRC.valid?(@token)
+    
+    @secret_id = @token[0,6].to_hex
+    @insert_counter = @token[7] * 256 + @token[6]
+    @timestamp = @token[10] * 65536 + @token[9] * 256 + @token[8]
+    @session_counter = @token[11]
+    @random_number = @token[13] * 256 + @token[12]
+  end
+  
+  # :stopdoc:
+  class InvalidOTPError < StandardError; end
+  class InvalidKeyError < StandardError; end
+  class BadCRCError < StandardError; end
+end # Yubikey::OTP

data/lib/yubikey.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'yubikey_ext'
+require 'yubikey/hex'
+require 'yubikey/otp'

data/spec/hex_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'hex' do
+  it 'should encode binary to hex' do
+    "i\266H\034\213\253\242\266\016\217\"\027\233X\315V".to_hex.
+      should == '69b6481c8baba2b60e8f22179b58cd56'
+    
+    "\354\336\030\333\347o\275\f33\017\0345Hq\333".to_hex.
+      should == 'ecde18dbe76fbd0c33330f1c354871db'
+  end
+  
+  it 'should decode hex to binary' do
+    '69b6481c8baba2b60e8f22179b58cd56'.to_bin.
+      should == "i\266H\034\213\253\242\266\016\217\"\027\233X\315V"
+    
+    'ecde18dbe76fbd0c33330f1c354871db'.to_bin.
+      should == "\354\336\030\333\347o\275\f33\017\0345Hq\333"
+  end
+  
+  it 'should know whether a string is hex' do
+    'ecde18dbe76fbd0c33330f1c354871db'.hex?.should == true
+    'dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh'.modhex?.should == true
+    
+    'foobar'.hex?.should == false
+    'test'.modhex?.should == false
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'yubikey'

data/spec/yubikey_ext_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+$:.unshift File.dirname(__FILE__) + '/../ext/yubikey_ext'
+require 'yubikey_ext.so'
+
+describe 'yubikey_ext' do
+  it 'should decode modhex' do
+    Yubikey::ModHex.decode('hknhfjbrjnlnldnhcujvddbikngjrtgh').should == "i\266H\034\213\253\242\266\016\217\"\027\233X\315V"
+    Yubikey::ModHex.decode('urtubjtnuihvntcreeeecvbregfjibtn').should == "\354\336\030\333\347o\275\f33\017\0345Hq\333"
+    
+    Yubikey::ModHex.decode('dteffuje').should == "-4N\203"
+    
+    Yubikey::ModHex.decode('ifhgieif').should == 'test'
+    Yubikey::ModHex.decode('hhhvhvhdhbid').should == 'foobar'
+    
+    Yubikey::ModHex.decode('cc').should == "\000"
+  end
+  
+  it 'should raise if modhex string length uneven' do
+    lambda { Yubikey::ModHex.decode('ifh') }.should raise_error(ArgumentError)
+  end
+  
+  it 'should decrypt aes' do
+    key = '72992427a3b8ccd20697493b5532561f'.to_bin
+    state = 'ddf43aec57366784e061a12f767e728a'.to_bin
+    plain = '619dd70df3b30300de1bdb00ffbf6f26'.to_bin
+    
+    Yubikey::AES.decrypt(state, key).should == plain
+  end
+  
+  it 'should raise if aes key or state length is not 16' do
+    lambda { Yubikey::AES.decrypt("i\266H\034\213\253\242\266\016\217\"\027\233X\315V", 'test') }.
+      should raise_error(ArgumentError)
+    
+    lambda { Yubikey::AES.decrypt('test', "\354\336\030\333\347o\275\f33\017\0345Hq\333") }.
+      should raise_error(ArgumentError)
+  end
+  
+  it 'should check a crc' do
+    Yubikey::CRC.valid?('619dd70df3b30300de1bdb00ffbf6f26'.to_bin).should == true
+    Yubikey::CRC.valid?('ddf43aec57366784e061a12f767e728a'.to_bin).should == false
+  end
+  
+  it 'should raise if crc token length not 16' do
+    lambda { Yubikey::CRC.valid?('619dd70df3b30300de1bdb00ffbf6f'.to_bin) }.
+      should raise_error(ArgumentError)
+  end
+end

data/spec/yubikey_otp_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'Yubikey::OTP' do
+  it 'should parse a otp' do
+    token = Yubikey::OTP.new('dteffujehknhfjbrjnlnldnhcujvddbikngjrtgh', 'ecde18dbe76fbd0c33330f1c354871db')
+    
+    token.public_id.should == 'dteffuje'
+    token.secret_id.should == '8792ebfe26cc'
+    token.insert_counter.should == 19
+    token.session_counter.should == 17
+    token.timestamp.should == 49712
+    token.random_number.should == 40904
+  end
+  
+  it 'should raise if key or otp invalid' do
+    otp = 'hknhfjbrjnlnldnhcujvddbikngjrtgh'
+    key = 'ecde18dbe76fbd0c33330f1c354871db'
+    
+    lambda { Yubikey::OTP.new(key, key) }.should raise_error(Yubikey::OTP::InvalidOTPError)
+    lambda { Yubikey::OTP.new(otp, otp) }.should raise_error(Yubikey::OTP::InvalidKeyError)
+    
+    lambda { Yubikey::OTP.new(otp[0,31], key) }.should raise_error(Yubikey::OTP::InvalidOTPError)
+    lambda { Yubikey::OTP.new(otp, key[0,31]) }.should raise_error(Yubikey::OTP::InvalidKeyError)
+    
+    lambda { Yubikey::OTP.new(otp[1,31]+'d', key) }.should raise_error(Yubikey::OTP::BadCRCError)
+  end
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: yubikey
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jonathan Rudenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A library to decode, decrypt and parse Yubikey one-time passwords.
+email: jon335@gmail.com
+executables: []
+
+extensions: 
+- ext/yubikey_ext/extconf.rb
+extra_rdoc_files: 
+- ext/yubikey_ext/yubikey_ext.c
+- README.rdoc
+- LICENSE
+files: 
+- lib/yubikey.rb
+- lib/yubikey/hex.rb
+- lib/yubikey/otp.rb
+- examples/otp.rb
+- spec/hex_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yubikey_ext_spec.rb
+- spec/yubikey_otp_spec.rb
+- ext/yubikey_ext/ykaes.c
+- ext/yubikey_ext/ykcrc.c
+- ext/yubikey_ext/ykmodhex.c
+- ext/yubikey_ext/yubikey_ext.c
+- ext/yubikey_ext/yubikey.h
+- ext/yubikey_ext/extconf.rb
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/titanous/yubikey
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yubikey
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A library to decode, decrypt and parse Yubikey one-time passwords.
+test_files: []
+