mfrc522 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4595ef4728e8788e2448de76ce8b64ea6d0ae167
-  data.tar.gz: 6c364cc01a7147ea40675152b6538017d8e67b09
+  metadata.gz: 3ae695036f039f29942ea9a3e46cb365fb1e4fe7
+  data.tar.gz: c144d7dcf96074d047a3eba55523a27f2b3a74fb
 SHA512:
-  metadata.gz: 2f87dd8826b8e949b2a6813a035dbe598a3e24e69cba4da220ac7c5483aae6d3d5e6d948a2ad5f83967909fc7cad97c0a2e810d4c4187e5e11c2827f620258c8
-  data.tar.gz: 1ea6d484be7cf70ded2e82549d2e853a5bbfbe6e6488fc0ff0ed917bce5e5b060696738c6eae97b2cda90b773ec560cf1a47424919aea11b2e6869b5d1193269
+  metadata.gz: ae5877e53851c774fdf68ac3ccb65fe3623d6a446e42e39f1ac843b0ecc8bcb7aaac68bf657ce632154d0e6876ee5786e884acebb9d9c53156818f6c9f1a8ecf
+  data.tar.gz: b8e8e5df57870a7da924c7a8dd207d2fa6ba89be281116c1b7ba5da5327bd3eb35b1e402bc80d61e06bce57293c8325f46dad25aca5409da129668c6f52e4ee7

data/lib/mfrc522.rb

@@ -1,8 +1,19 @@
 require 'pi_piper'
 
+# For 3DES auth
+require 'openssl'
+require 'securerandom'
+
+require 'mifare/base'
+require 'mifare/classic'
+require 'mifare/ultralight'
+require 'mifare/ultralight_c'
+require 'mifare/plus'
+require 'mifare/des_fire'
+
 include PiPiper
 
-class Mfrc522
+class MFRC522
 
   # PICC commands used by the PCD to manage communication with several PICCs (ISO 14443-3, Type A, section 6.4)
   PICC_REQA           = 0x26  # REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame.
@@ -26,8 +37,8 @@ class Mfrc522
   # The commands used for MIFARE Ultralight (from http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf, Section 8.6)
   # The PICC_MF_READ and PICC_MF_WRITE can also be used for MIFARE Ultralight.
   PICC_UL_WRITE       = 0xA2  # Writes one 4 byte page to the PICC.
-  # The commands here is for 3DES Authentication
-  PICC_MF_3DES_AUTH   = 0x1A
+  # The commands here is for Ultralight 3DES Authentication
+  PICC_UL_3DES_AUTH   = 0x1A
   #
   PICC_MF_ACK         = 0x0A   # Mifare Acknowledge
 
@@ -128,7 +139,7 @@ class Mfrc522
     antenna_on # Turn antenna on. They were disabled by the reset.
   end
 
-  # MFRC522 software reset
+  # PCD software reset
   def soft_reset
     write_spi(CommandReg, PCD_SoftReset)
     sleep 1.0 / 20.0 # wait 50ms
@@ -177,8 +188,7 @@ class Mfrc522
 
   # Turn antenna on
   def antenna_on
-    value = read_spi(TxControlReg)
-    write_spi_set_bitmask(TxControlReg, 0x03) if (value & 0x03) != 0x03
+    write_spi_set_bitmask(TxControlReg, 0x03)
   end
 
   # Turn antenna off
@@ -240,7 +250,7 @@ class Mfrc522
     return :status_ok
   end
 
-  # PICC transceive helper
+  # PCD transceive helper
   def communicate_with_picc(command, send_data, framing_bit = 0, check_crc = false)
     wait_irq = 0x00
     wait_irq = 0x10 if command == PCD_MFAuthent
@@ -309,7 +319,7 @@ class Mfrc522
     return :status_ok
   end
 
-  # Instruct PICC in ACTIVE state go to HALT
+  # Instruct PICC in ACTIVE state go to HALT state
   def picc_halt
     buffer = [PICC_HLTA, 0]
 
@@ -370,6 +380,7 @@ class Mfrc522
           # ensure there's nothing weird in buffer
           if buffer.size != 6 && !buffer.select{|b| !buffer.is_a?(Fixnum)}.empty?
             current_level_known_bits = 0
+            buffer = []
             next
           end
 
@@ -439,6 +450,29 @@ class Mfrc522
     return :status_ok, uid, sak
   end
 
+  # Trying to wake it up again
+  def reestablish_picc_communication(uid)
+    status = picc_halt
+    return status if status != :status_ok
+
+    status = picc_request(PICC_WUPA)
+    return status if status != :status_ok
+
+    status, new_uid, new_sak = picc_select
+    return status if status != :status_ok
+
+    if uid == new_uid
+      return :status_ok
+    else
+      return :status_different_card_detected
+    end
+  end
+
+  # ISO/IEC 14443-4 select
+  def iso_select
+    
+  end
+
   # Lookup error message
   def error_type(error)
     case error
@@ -462,6 +496,12 @@ class Mfrc522
       'Incorrect select acknowledge'
     when :status_auth_failed
       'Authentication failed'
+    when :status_data_length_error
+      'Incorrect input data length'
+    when :status_incorrect_input
+      'Incorrect input'
+    when :status_different_card_detected
+      'Different card detected while reselecting'
     when :status_error
       'Something went wrong'
     else
@@ -470,36 +510,51 @@ class Mfrc522
   end
 
   # Lookup PICC name using sak
-  def picc_type(sak)
-    sak &= 0x7F
-
-    case sak
-    when 0x04
-      'PICC_TYPE_NOT_COMPLETE'
-    when 0x09
-      'PICC_TYPE_MIFARE_MINI'
-    when 0x08
-      'PICC_TYPE_MIFARE_1K'
-    when 0x18
-      'PICC_TYPE_MIFARE_4K'
-    when 0x00
-      'PICC_TYPE_MIFARE_UL'
-    when 0x10, 0x11
-      'PICC_TYPE_MIFARE_PLUS'
-    when 0x01
-      'PICC_TYPE_TNP3XXX'
-    when 0x20
-      'PICC_TYPE_ISO_14443_4'
-    when 0x40
-      'PICC_TYPE_ISO_18092'
-    else
-      'PICC_TYPE_UNKNOWN'
+  def identify_model(sak)
+    # SAK coding separation reference:
+    # http://cache.nxp.com/documents/application_note/AN10833.pdf
+    # http://www.nxp.com/documents/application_note/130830.pdf
+    if sak & 0x04 != 0
+      return :picc_uid_not_complete
     end
-  end
 
-  # Check if Mifare PICC
-  def mifare?(sak)
-    sak & 0x20 != 1
+    if sak & 0x02 != 0
+      return :picc_reserved_future_use
+    end
+
+    if sak & 0x08 != 0
+      if sak & 0x10 != 0
+        return :picc_mifare_4k
+      end
+
+      if sak & 0x01 != 0
+        return :picc_mifare_mini
+      end
+      
+      return :picc_mifare_1k
+    end
+
+    if sak & 0x10 != 0
+      if sak & 0x01 != 0
+        return :picc_mifare_plus_4k_sl2
+      end
+        
+      return :picc_mifare_plus_2k_sl2
+    end
+
+    if sak == 0x00
+      return :picc_mifare_ultralight
+    end
+
+    if sak & 0x20 != 0
+      return :picc_iso_14443_4
+    end
+
+    if sak & 0x40 != 0
+      return :picc_iso_18092
+    end
+
+    return :picc_unknown
   end
 
   # Start encrypted Crypto1 communication between reader and Mifare PICC
@@ -516,7 +571,7 @@ class Mfrc522
     #
     buffer = [command, block_addr]
     buffer += sector_key[0..5]
-    buffer += uid[-4..-1]
+    buffer += uid[0..3]
 
     status, _received_data, _valid_bits = communicate_with_picc(PCD_MFAuthent, buffer)
 
@@ -531,50 +586,55 @@ class Mfrc522
     write_spi_clear_bitmask(Status2Reg, 0x08) # Clear MFCrypto1On bit
   end
 
-  def mifare_3des_authenticate(des_key)
-    require 'openssl'
-    require 'securerandom'
-
-    # Cipher
-    cipher = OpenSSL::Cipher.new 'des-ede3-cbc'
-    cipher.key = [des_key*2].pack('H*')
-    cipher.padding = 0
-
+  def mifare_ultralight_3des_check
     # Ask for authentication
-    buffer = [PICC_MF_3DES_AUTH, 0x00]
+    buffer = [PICC_UL_3DES_AUTH, 0x00]
     status, received_data = mifare_transceive(buffer)
     return status if status != :status_ok
     return :status_unknown_data if received_data[0] != 0xAF
 
+    return :status_ok, received_data
+  end
+
+  def mifare_ultralight_3des_authenticate(des_key)
+    status, received_data = mifare_ultralight_3des_check
+    return status if status != :status_ok
+
     # Use received data as IV for next transmission
     next_iv = received_data[1..8]
 
+    # Cipher
+    cipher = OpenSSL::Cipher.new 'des-ede3-cbc'
+    cipher.key = [des_key*2].pack('H*')
+    cipher.padding = 0
+
     # Decrypt challenge random number and rotate it by 8 bits
     cipher.decrypt
     cipher.iv = "\x00"*8
     challenge = received_data[1..8].pack('C*')
     challenge = cipher.update(challenge) + cipher.final
-    challenge.rotate!
+    challenge = challenge.bytes.rotate
 
     # Generate 8 bytes random number and encrypt the response 
     random_number = SecureRandom.random_bytes(8)
     cipher.encrypt
-    cipher.iv = next_iv
-    response = cipher.update(challenge.pack('C*') + random_number) + cipher.final
+    cipher.iv = next_iv.pack('C*')
+    response = cipher.update(random_number + challenge.pack('C*')) + cipher.final
+    response = response.bytes
 
     # Receive verification
-    buffer = [0xAF, [response].unpack('H*')]
+    buffer = [0xAF] + response
     status, received_data = mifare_transceive(buffer)
     return status if status != :status_ok
     return :status_unknown_data if received_data[0] != 0x00
 
     # Check if verification matches random_number rotated by 8 bits
     cipher.decrypt
-    cipher.iv = [response[-16..-1]].pack('H*')
+    cipher.iv = response[-8..-1].pack('C*')
     verification = received_data[1..8].pack('C*')
     verification = cipher.update(verification) + cipher.final
 
-    if random_number.bytes.rotate! != verification
+    if random_number.bytes.rotate != verification.bytes
       picc_halt
       return :status_auth_failed
     end
@@ -595,10 +655,10 @@ class Mfrc522
 
     # Data exists, check CRC and return
     if received_data.size > 1
-      return :status_crc_error if received_data.count < 2 || valid_bits != 0
+      return :status_crc_error if received_data.size < 3 || valid_bits != 0
 
       status = check_crc(received_data)
-      return status, received_data
+      return status, received_data[0..-3]
     end
 
     # Data doesn't exist, check mifare acknowledge
@@ -608,133 +668,4 @@ class Mfrc522
     return :status_ok
   end
 
-  # Read Mifare block address
-  def mifare_read(block_addr)
-    buffer = [PICC_MF_READ, block_addr]
-
-    status, received_data = mifare_transceive(buffer)
-    return status if status != :status_ok
-
-    return :status_ok, received_data
-  end
-
-  # Write Mifare block address
-  def mifare_write(block_addr, send_data)
-    buffer = [PICC_MF_WRITE, block_addr]
-
-    # Ask PICC if we can write to block_addr
-    status = mifare_transceive(buffer)
-    return status if status != :status_ok
-
-    # Then start transfer our data
-    status = mifare_transceive(send_data)
-    return status if status != :status_ok
-
-    return :status_ok
-  end
-
-  # Write helper for Mifare UL
-  def mifare_ultralight_write(page, send_data)
-    # Page 2-15, each 4 bytes
-    buffer = [PICC_UL_WRITE, page]
-    buffer += send_data[0..3]
-
-    status = mifare_transceive(buffer)
-    return status if status != :status_ok
-
-    return :status_ok
-  end
-
-  # Helper for reading value block
-  def mifare_get_value(block_addr)
-    status, received_data = mifare_read(block_addr)
-    return status if status != :status_ok
-  
-    value = (received_data[3] << 24) + (received_data[2] << 16) + (received_data[1] << 8) + received_data[0]
-  
-    return :status_ok, value
-  end
-
-  # Helper for writing value block
-  def mifare_set_value(block_addr, value)
-    # Value block format
-    #
-    # byte 0..3:   32 bit value in little endian
-    # byte 4..7:   copy of byte 0..3, with inverted bits (aka. XOR 255)
-    # byte 8..11:  copy of byte 0..3
-    # byte 12:     index of backup block (can be any value)
-    # byte 13:     copy of byte 12 with inverted bits (aka. XOR 255)
-    # byte 14:     copy of byte 12
-    # byte 15:     copy of byte 13
-    buffer = []
-    buffer[0]  = value & 0xFF
-    buffer[1]  = (value >> 8) & 0xFF
-    buffer[2]  = (value >> 16) & 0xFF
-    buffer[3]  = (value >> 24) & 0xFF
-    buffer[4]  = ~buffer[0]
-    buffer[5]  = ~buffer[1]
-    buffer[6]  = ~buffer[2]
-    buffer[7]  = ~buffer[3]
-    buffer[8]  = buffer[0]
-    buffer[9]  = buffer[1]
-    buffer[10] = buffer[2]
-    buffer[11] = buffer[3]
-    buffer[12] = block_addr
-    buffer[13] = ~block_addr
-    buffer[14] = buffer[12]
-    buffer[15] = buffer[13]
-  
-    mifare_write(block_addr, buffer)
-  end
-
-  # Helper for increment, decrement, and restore command
-  def mifare_two_step(command, block_addr, value)
-    buffer = [command, block_addr]
-    send_data = [ # Split integer into array of bytes
-      value & 0xFF,
-      (value >> 8) & 0xFF,
-      (value >> 16) & 0xFF,
-      (value >> 24) & 0xFF
-    ]
-    
-    # Ask PICC if we can write to block_addr
-    status = mifare_transceive(buffer)
-    return status if status != :status_ok
-
-    # Then start transfer our data
-    status = mifare_transceive(send_data, true) # Accept timeout
-    return status if status != :status_ok
-
-    return :status_ok
-  end
-
-  # Mifare increment helper
-  # MIFARE Classic only
-  def mifare_increment(block_addr, delta)
-    mifare_two_step(PICC_MF_INCREMENT, block_addr, delta)
-  end
-
-  # Mifare decrement helper
-  # MIFARE Classic only
-  def mifare_decrement(block_addr, delta)
-    mifare_two_step(PICC_MF_DECREMENT, block_addr, delta)
-  end
-
-  # Mifare restore helper
-  # MIFARE Classic only
-  def mifare_restore(block_addr)
-    mifare_two_step(PICC_MF_RESTORE, block_addr, 0)
-  end
-
-  # Mifare transfer helper
-  # MIFARE Classic only
-  def mifare_transfer(block_addr)
-    buffer = [PICC_MF_TRANSFER, block_addr]
-
-    status = mifare_transceive(buffer)
-    return status if status != :status_ok
-
-    return :status_ok
-  end
 end
-

data/lib/mifare/base.rb

@@ -0,0 +1,22 @@
+module Mifare
+  class Base
+
+    attr_reader :uid
+    attr_reader :sak
+
+    def initialize(pcd, uid, sak)
+      @pcd = pcd
+      @uid = uid
+      @sak = sak
+    end
+
+    def resume_communication
+      @pcd.reestablish_picc_communication(@uid)
+    end
+
+    def halt
+      @pcd.picc_halt
+    end
+
+  end
+end

data/lib/mifare/classic.rb

@@ -0,0 +1,139 @@
+module Mifare
+  class Classic < Base
+
+    def auth(block_addr, key = {})
+      if key[:a]
+        @pcd.mifare_crypto1_authenticate(MFRC522::PICC_MF_AUTH_KEY_A, block_addr, key[:a], @uid)
+      elsif key[:b]
+        @pcd.mifare_crypto1_authenticate(MFRC522::PICC_MF_AUTH_KEY_B, block_addr, key[:b], @uid)
+      else
+        :status_incorrect_input
+      end
+    end
+
+    def deauth
+      @pcd.mifare_crypto1_deauthenticate
+    end
+
+    def read(block_addr)
+      buffer = [MFRC522::PICC_MF_READ, block_addr]
+
+      status, received_data = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      return :status_ok, received_data
+    end
+
+    def write(block_addr, send_data)
+      return :status_data_length_error if send_data.size != 16
+
+      buffer = [MFRC522::PICC_MF_WRITE, block_addr]
+
+      # Ask PICC if we can write to block_addr
+      status = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      # Then start transfer our data
+      status = @pcd.mifare_transceive(send_data)
+      return status if status != :status_ok
+
+      return :status_ok
+    end
+
+    def read_value(block_addr)
+      status, received_data = read(block_addr)
+      return status if status != :status_ok
+    
+      value = (received_data[3] << 24) +
+              (received_data[2] << 16) +
+              (received_data[1] << 8) +
+              received_data[0]
+    
+      return :status_ok, value
+    end
+
+    def write_value(block_addr, value)
+      return :status_data_length_error if value.size > 4
+
+      # Value block format
+      #
+      # byte 0..3:   32 bit value in little endian
+      # byte 4..7:   copy of byte 0..3, with inverted bits (aka. XOR 255)
+      # byte 8..11:  copy of byte 0..3
+      # byte 12:     index of backup block (can be any value)
+      # byte 13:     copy of byte 12 with inverted bits (aka. XOR 255)
+      # byte 14:     copy of byte 12
+      # byte 15:     copy of byte 13
+      buffer = []
+      buffer[0]  = value & 0xFF
+      buffer[1]  = (value >> 8) & 0xFF
+      buffer[2]  = (value >> 16) & 0xFF
+      buffer[3]  = (value >> 24) & 0xFF
+      buffer[4]  = ~buffer[0]
+      buffer[5]  = ~buffer[1]
+      buffer[6]  = ~buffer[2]
+      buffer[7]  = ~buffer[3]
+      buffer[8]  = buffer[0]
+      buffer[9]  = buffer[1]
+      buffer[10] = buffer[2]
+      buffer[11] = buffer[3]
+      buffer[12] = block_addr
+      buffer[13] = ~block_addr
+      buffer[14] = buffer[12]
+      buffer[15] = buffer[13]
+    
+      write(block_addr, buffer)
+    end
+
+    # Increment: Increments the contents of a block and stores the result in the internal Transfer Buffer
+    def increment(block_addr, delta)
+      two_step(MFRC522::PICC_MF_INCREMENT, block_addr, delta)
+    end
+
+    # Decrement: Decrements the contents of a block and stores the result in the internal Transfer Buffer
+    def decrement(block_addr, delta)
+      two_step(MFRC522::PICC_MF_DECREMENT, block_addr, delta)
+    end
+
+    # Restore: Moves the contents of a block into the internal Transfer Buffer
+    def restore(block_addr)
+      two_step(MFRC522::PICC_MF_RESTORE, block_addr, 0)
+    end
+
+    # Transfer: Writes the contents of the internal Transfer Buffer to a value block
+    def transfer(block_addr)
+      buffer = [MFRC522::PICC_MF_TRANSFER, block_addr]
+
+      status = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      return :status_ok
+    end
+
+    private
+
+    # Helper for increment, decrement, and restore command
+    def two_step(command, block_addr, value)
+      return :status_data_length_error if value.size > 4
+
+      buffer = [command, block_addr]
+      send_data = [ # Split integer into array of bytes
+        value & 0xFF,
+        (value >> 8) & 0xFF,
+        (value >> 16) & 0xFF,
+        (value >> 24) & 0xFF
+      ]
+      
+      # Ask PICC if we can write to block_addr
+      status = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      # Then start transfer our data
+      status = @pcd.mifare_transceive(send_data, true) # Accept timeout
+      return status if status != :status_ok
+
+      return :status_ok
+    end
+
+  end
+end

data/lib/mifare/des_fire.rb

@@ -0,0 +1,7 @@
+module Mifare
+  class DESFire < Base
+    def self.say
+      puts 'yo'
+    end
+  end
+end

data/lib/mifare/plus.rb

@@ -0,0 +1,7 @@
+module Mifare
+  class Plus < Base
+    def self.say
+      puts 'Hello'
+    end
+  end
+end

data/lib/mifare/ultralight.rb

@@ -0,0 +1,44 @@
+module Mifare
+  class Ultralight < Base
+
+    def initialize(pcd, uid, sak)
+      super
+      @is_c = false
+
+      # Check if Ultralight C
+      status, received_data = @pcd.mifare_ultralight_3des_check
+      if status == :status_ok
+        extend UltralightC
+        @is_c = true
+      end
+      resume_communication
+    end
+
+    def read(block_addr)
+      buffer = [MFRC522::PICC_MF_READ, block_addr]
+
+      status, received_data = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      return :status_ok, received_data
+    end
+
+    def write(page, send_data)
+      return :status_data_length_error if send_data.size != 4
+
+      # Page 2-15, each 4 bytes
+      buffer = [MFRC522::PICC_UL_WRITE, page]
+      buffer += send_data
+
+      status = @pcd.mifare_transceive(buffer)
+      return status if status != :status_ok
+
+      return :status_ok
+    end
+
+    def is_c?
+      @is_c
+    end
+
+  end
+end

data/lib/mifare/ultralight_c.rb

@@ -0,0 +1,42 @@
+module Mifare
+  module UltralightC
+    
+    # Using 16 bytes hex string for 3DES authentication
+    def auth(key)
+      @pcd.mifare_ultralight_3des_authenticate(key)
+    end
+
+    def write_des_key(key)
+      # key should be 16 bytes long
+      bytes = [key].pack('H*').unpack('C*')
+      return :status_data_length_error if bytes.size != 16
+
+      # Key1
+      write(0x2C, bytes[4..7].reverse)
+      write(0x2D, bytes[0..3].reverse)
+      # Key2
+      write(0x2E, bytes[12..15].reverse)
+      write(0x2F, bytes[8..11].reverse)
+    end
+
+    def counter_increment(value)
+      # you can set any value between 0x0000 to 0xFFFF on the first write (initialize)
+      # after initialized, counter can only be incremented by 0x01 ~ 0x0F
+      write(0x29, [value & 0xFF, (value >> 8) & 0xFF, 0x00, 0x00])
+    end
+
+    def enable_protection_from(block_addr)
+      # authentication will be required from `block_addr` to 0x2F
+      # valid value are from 0x03 to 0x30
+      # set to 0x30 to disable memory protection
+      write(0x2A, [block_addr & 0x3F, 0x00, 0x00, 0x00])
+    end
+
+    def set_protection_type(type)
+      # set to 0 for read-write access restriction (default)
+      # set to 1 for write access restriction
+      write(0x2B, [type & 0x01, 0x00, 0x00, 0x00])
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mfrc522
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - atitan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pi_piper
@@ -37,6 +37,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mfrc522.rb
+- lib/mifare/base.rb
+- lib/mifare/classic.rb
+- lib/mifare/des_fire.rb
+- lib/mifare/plus.rb
+- lib/mifare/ultralight.rb
+- lib/mifare/ultralight_c.rb
 homepage: https://github.com/atitan/MFRC522_Ruby
 licenses:
 - MIT