semacode 0.7.2 → 0.7.3

data/CHANGELOG

@@ -22,4 +22,19 @@ CHANGELOG
     
     * Fixes compiler errors with Fink not finding malloc.h
     
-    * Given up on making the gem do auto-require
+    * Given up on making the gem do auto-require
+    
+    * Fixes a memory leak where the encoding list wasn't being freed.
+    
+  
+  2007-03-04  guido
+  
+    * Free up internal memory allocated before we throw an exception
+    
+    * Throw ArgError and RangeError exceptions rather than Runtime exceptions
+    
+    * Don't return an inconsistent semacode when presented with overlong input
+    
+    * Don't fail quietly either, throw an exception
+    
+    * Very conservatively use a far smaller maximum value for input length than the header file suggests

data/README

@@ -141,3 +141,9 @@ The C code can throw runtime exceptions. Be sure to include
 a catch block if you want to use this in production. Mostly
 the exceptions are not recoverable, except for when the data
 is too long, in which case you can shorten it and try again.
+
+There are two type of exceptions that it will throw. The first
+is a RangeError exception, which happens when the input is too
+long or when it just can't find a fit for the data. The second
+is a ArgumentError (ArgError?) exception that gets thrown when
+the input contains data it cannot handle.

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s| 
   s.name = "semacode"
-  s.version = "0.7.2"
+  s.version = "0.7.3"
   s.author = "Guido Sohne"
   s.email = "guido@sohne.net"
   s.homepage = "http://sohne.net/projects/semafox/"

data/ext/iec16022ecc200.c

@@ -211,8 +211,7 @@ ecc200placement (int *array, int NR, int NC)
 static void
 ecc200 (unsigned char *binary, int bytes, int datablock, int rsblock)
 {
-   int blocks = (bytes + 2) / datablock,
-      b;
+   int blocks = (bytes + 2) / datablock, b;
    rs_init_gf (0x12d);
    rs_init_code (rsblock, 1);
    for (b = 0; b < blocks; b++)
@@ -240,7 +239,8 @@ ecc200encode (unsigned char *t, int tl, unsigned char *s, int sl, char *encoding
       sp = 0;
    if (strlen (encoding) < sl)
    {
-      rb_raise(rb_eRuntimeError,  "encoding string too short");
+     free(encoding);
+      rb_raise(rb_eArgError,  "encoding string too short");
       return 0;
    }
    // do the encoding
@@ -281,7 +281,8 @@ ecc200encode (unsigned char *t, int tl, unsigned char *s, int sl, char *encoding
                {
                   if (newenc == 'x')
                   {
-                     rb_raise(rb_eRuntimeError,  "cannot encode character in X12", c);
+                     free(encoding);
+                     rb_raise(rb_eArgError,  "cannot encode character in X12", c);
                      return 0;
                   }
                   c &= 0x7f;
@@ -295,7 +296,8 @@ ecc200encode (unsigned char *t, int tl, unsigned char *s, int sl, char *encoding
                {
                   if (newenc == 'x')
                   {
-                     rb_raise(rb_eRuntimeError,  "cannot encode character in X12", c);
+                     free(encoding);
+                     rb_raise(rb_eArgError,  "cannot encode character in X12", c);
                      return 0;
                   }
                   if (c < 32)
@@ -318,6 +320,7 @@ ecc200encode (unsigned char *t, int tl, unsigned char *s, int sl, char *encoding
                            out[p++] = (w - s3);
                         } else
                         {
+                           free(encoding);
                            rb_raise(rb_eRuntimeError,  "this should not be happening!", c);
                            return 0;
                         }
@@ -429,7 +432,8 @@ ecc200encode (unsigned char *t, int tl, unsigned char *s, int sl, char *encoding
          }
          break;
       default:
-         rb_raise(rb_eRuntimeError,  "unknown encoding attempted");
+         free(encoding);
+         rb_raise(rb_eArgError,  "unknown encoding attempted");
          return 0;              // failed
       }
    }
@@ -798,12 +802,28 @@ void iec16022init(int *Wptr, int *Hptr, const char *barcode)
 unsigned char *
 iec16022ecc200 (int *Wptr, int *Hptr, char **encodingptr, int barcodelen, unsigned char *barcode, int *lenp, int *maxp, int *eccp)
 {
-   unsigned char binary[3000];  // encoded raw data and ecc to place in barcode
+  // GS
+  // max semacode size is 3116 (from iec16022ecc200.h)
+  // we over compensate and check that the input is within this length
+  // to avoid any buffer overflow conditions.
+   unsigned char binary[4096];  // encoded raw data and ecc to place in barcode
    int W = 0,
       H = 0;
    char *encoding = 0;
    unsigned char *grid = 0;
    struct ecc200matrix_s *matrix;
+   
+   // GS
+   // using the length from the 144x144 semacode in the matrix
+   // I don't trust the 3116 maximum length value ... and
+   // besides how many characters do you really need in a
+   // semacode?
+   
+   if(barcodelen > 1556) {
+     rb_raise(rb_eRangeError,  "barcode is too long (> 1556 chars)");
+     return NULL;
+   }
+   
    memset (binary, 0, sizeof (binary));
    if (encodingptr)
       encoding = *encodingptr;
@@ -818,7 +838,7 @@ iec16022ecc200 (int *Wptr, int *Hptr, char **encodingptr, int barcodelen, unsign
       for (matrix = ecc200matrix; matrix->W && (matrix->W != W || matrix->H != H); matrix++);
       if (!matrix->W)
       {
-         rb_raise(rb_eRuntimeError,  "invalid size for barcode");
+         rb_raise(rb_eRangeError,  "invalid size for barcode");
          return 0;
       }
       if (!encoding)
@@ -831,7 +851,8 @@ iec16022ecc200 (int *Wptr, int *Hptr, char **encodingptr, int barcodelen, unsign
             e = encmake (barcodelen, barcode, &len, 0);
             if (len > matrix->bytes)
             {
-               rb_raise(rb_eRuntimeError,  "cannot make barcode fit");
+               free(e);
+               rb_raise(rb_eRangeError,  "cannot make barcode fit");
                return 0;
             }
          }
@@ -860,7 +881,8 @@ iec16022ecc200 (int *Wptr, int *Hptr, char **encodingptr, int barcodelen, unsign
       }
       if (!matrix->W)
       {
-         rb_raise(rb_eRuntimeError,  "overlong barcode");
+         free(encoding);
+         rb_raise(rb_eRangeError,  "overlong barcode");
          return 0;
       }
       W = matrix->W;
@@ -868,7 +890,8 @@ iec16022ecc200 (int *Wptr, int *Hptr, char **encodingptr, int barcodelen, unsign
    }
    if (!ecc200encode (binary, matrix->bytes, barcode, barcodelen, encoding, lenp))
    {
-      rb_raise(rb_eRuntimeError,  "barcode too long for expected encoding");
+      free(encoding);
+      rb_raise(rb_eRangeError,  "barcode too long for expected encoding");
       return 0;
    }
    // ecc code

data/ext/reedsol.h

@@ -1,3 +1,5 @@
+/* don't compile in the main function from reedsol.c */
+#define LIB
 
 void rs_init_gf(int poly);
 void rs_init_code(int nsym, int index);

data/ext/semacode.c

@@ -38,12 +38,17 @@ Due to a bug in the underlying encoder, we do two things
 semacode_t* 
 encode_string(semacode_t *semacode, int message_length, char *message)
 {
+  /* avoid obvious bad cases */
+  if(semacode == NULL || message == NULL || message_length < 1) {
+    return NULL;
+  }
+    
   /* deallocate if exists already */
-  if(semacode !=NULL && semacode->data != NULL)
+  if(semacode->data != NULL)
     free(semacode->data);
 
   /* deallocate if exists already */
-  if(semacode !=NULL && semacode->encoding != NULL)
+  if(semacode->encoding != NULL)
     free(semacode->encoding);
         
   bzero(semacode, sizeof(semacode_t));
@@ -87,6 +92,7 @@ semacode_free(semacode_t *semacode)
     if(semacode->data != NULL)
       free(semacode->encoding);
       free(semacode->data);      
+    /* zero before freeing */
     bzero(semacode, sizeof(semacode));
     free(semacode);
   }
@@ -100,7 +106,7 @@ semacode_allocate(VALUE klass)
 }
 
 /* 
-  Initialize the semacode. This function is called after a semaode is
+  Initialize the semacode. This function is called after a semacode is
   created. Ruby objects are created using a new method, and then initialized
   via the 'initialize' method once they have been allocated.
   
@@ -358,6 +364,7 @@ Init_semacode_native()
 {
   rb_mSemacode = rb_define_module ("DataMatrix");
   rb_cEncoder = rb_define_class_under(rb_mSemacode, "Encoder", rb_cObject);
+  
   rb_define_alloc_func(rb_cEncoder, semacode_allocate);
   
   rb_define_method(rb_cEncoder, "initialize", semacode_init, 1);

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: semacode
 version: !ruby/object:Gem::Version 
-  version: 0.7.2
+  version: 0.7.3
 date: 2007-03-04 00:00:00 +00:00
 summary: Create semacodes (2D barcodes) using Ruby.
 require_paths: