3 * Reading and writing buffers of stuff
5 * (c) 2005 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the Python interface to Catacomb.
12 * Catacomb/Python is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * Catacomb/Python is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with Catacomb/Python; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 /*----- Header files ------------------------------------------------------*/
29 #include "catacomb-python.h"
31 /*----- Data structures ---------------------------------------------------*/
33 typedef struct buf_pyobj
{
39 static PyTypeObject
*rbuf_pytype
, *wbuf_pytype
;
40 #define RBUF_PYCHECK(o) PyObject_TypeCheck((o), rbuf_pytype)
41 #define WBUF_PYCHECK(o) PyObject_TypeCheck((o), wbuf_pytype)
42 #define BUF_B(o) (&((buf_pyobj *)(o))->b)
43 #define BUF_SUB(o) (((buf_pyobj *)(o))->sub)
45 /*----- Exceptions --------------------------------------------------------*/
47 static PyObject
*buferr
;
49 #define BUFERR(str) do { PyErr_SetString(buferr, str); goto end; } while (0)
51 /*----- Read buffers ------------------------------------------------------*/
53 static PyObject
*rbuf_pynew(PyTypeObject
*ty
, PyObject
*arg
, PyObject
*kw
)
58 static const char *const kwlist
[] = { "data", 0 };
60 if (!PyArg_ParseTupleAndKeywords(arg
, kw
, "s#:new", KWLIST
, &p
, &n
))
64 me
= (buf_pyobj
*)ty
->tp_alloc(ty
, 0);
66 buf_init(&me
->b
, q
, n
);
68 return ((PyObject
*)me
);
71 static void buf_pydealloc(PyObject
*me
)
74 Py_DECREF(BUF_SUB(me
));
76 xfree(BBASE(BUF_B(me
)));
80 static Py_ssize_t
rbuf_pysegcount(PyObject
*me
, Py_ssize_t
*nn
)
81 { if (nn
) *nn
= BSZ(BUF_B(me
)); return (1); }
83 static Py_ssize_t
rbuf_pyreadbuf(PyObject
*me
, Py_ssize_t seg
, void **q
)
84 { assert(seg
== 0); *q
= BCUR(BUF_B(me
)); return (BLEFT(BUF_B(me
))); }
86 static PyObject
*rbmeth_skip(PyObject
*me
, PyObject
*arg
)
90 if (!PyArg_ParseTuple(arg
, "O&:skip", convszt
, &n
)) goto end
;
91 if (!buf_get(BUF_B(me
), n
)) BUFERR("buffer exhausted");
97 static PyObject
*rbmeth_get(PyObject
*me
, PyObject
*arg
)
102 if (!PyArg_ParseTuple(arg
, "O&:get", convszt
, &n
)) goto end
;
103 if ((p
= buf_get(BUF_B(me
), n
)) == 0) BUFERR("buffer exhausted");
104 return (bytestring_pywrap(p
, n
));
109 #define RBMETH_GETU_(n, W, w) \
110 static PyObject *rbmeth_getu##w(PyObject *me, PyObject *arg) \
113 if (!PyArg_ParseTuple(arg, ":getu" #w)) goto end; \
114 if (buf_getu##w(BUF_B(me), &x)) BUFERR("buffer exhausted"); \
115 if (MASK##W <= ULONG_MAX) return (getulong(x)); \
116 else { kludge64 y; ASSIGN64(y, x); return (getk64(y)); } \
120 DOUINTCONV(RBMETH_GETU_
)
122 #define RBMETH_GETBLK_(n, W, w) \
123 static PyObject *rbmeth_getblk##w(PyObject *me, PyObject *arg) \
127 if (!PyArg_ParseTuple(arg, ":getblk" #w)) goto end; \
128 if ((q = buf_getmem##w(BUF_B(me), &sz)) == 0) \
129 BUFERR("buffer exhausted"); \
130 return (bytestring_pywrap(q, sz)); \
134 BUF_DOSUFFIXES(RBMETH_GETBLK_
)
136 #define RBMETH_GETBUF_(n, W, w) \
137 static PyObject *rbmeth_getbuf##w(PyObject *me, PyObject *arg) \
141 if (!PyArg_ParseTuple(arg, ":getbuf" #w)) goto end; \
142 if (buf_getbuf##w(BUF_B(me), &bb)) BUFERR("buffer exhausted"); \
143 b = PyObject_NEW(buf_pyobj, rbuf_pytype); \
147 return ((PyObject *)b); \
151 BUF_DOSUFFIXES(RBMETH_GETBUF_
)
153 static PyObject
*rbmeth_getmp(PyObject
*me
, PyObject
*arg
)
156 if (!PyArg_ParseTuple(arg
, ":getmp")) goto end
;
157 if ((x
= buf_getmp(BUF_B(me
))) == 0) BUFERR("buffer exhausted");
158 return (mp_pywrap(x
));
163 static PyObject
*rbmeth_getgf(PyObject
*me
, PyObject
*arg
)
166 if (!PyArg_ParseTuple(arg
, ":getgf")) goto end
;
167 if ((x
= buf_getmp(BUF_B(me
))) == 0) BUFERR("buffer exhausted");
168 return (gf_pywrap(x
));
173 static PyObject
*rbmeth_getecpt(PyObject
*me
, PyObject
*arg
, PyObject
*kw
)
175 PyObject
*cobj
= Py_None
;
176 static const char *const kwlist
[] = { "curve", 0 };
178 if (!PyArg_ParseTupleAndKeywords(arg
, kw
, "|O:getecpt", KWLIST
, &cobj
))
180 if (cobj
== Py_None
) cobj
= (PyObject
*)ecpt_pytype
;
181 if (!PyType_Check(cobj
) ||
182 !PyType_IsSubtype((PyTypeObject
*)cobj
, ecpt_pytype
))
183 TYERR("expected elliptic curve type");
184 if (buf_getec(BUF_B(me
), &pt
)) BUFERR("buffer exhausted");
185 return (ecpt_pywrapout(cobj
, &pt
));
190 static PyObject
*rbmeth_getecptraw(PyObject
*me
, PyObject
*arg
)
192 PyTypeObject
*cobj
= ecpt_pytype
;
194 if (!PyArg_ParseTuple(arg
, "O!:getecptraw", eccurve_pytype
, &cobj
))
196 if (ec_getraw(ECCURVE_C(cobj
), BUF_B(me
), &pt
)) BUFERR("buffer exhausted");
197 return (ecpt_pywrapout(cobj
, &pt
));
202 static PyObject
*rbmeth_getge(PyObject
*me
, PyObject
*arg
)
206 if (!PyArg_ParseTuple(arg
, "O!:getge", group_pytype
, &gobj
)) goto end
;
207 x
= G_CREATE(GROUP_G(gobj
));
208 if (G_FROMBUF(GROUP_G(gobj
), BUF_B(me
), x
)) BUFERR("buffer exhausted");
209 return (ge_pywrap(gobj
, x
));
211 if (x
) G_DESTROY(GROUP_G(gobj
), x
);
215 static PyObject
*rbmeth_getgeraw(PyObject
*me
, PyObject
*arg
)
219 if (!PyArg_ParseTuple(arg
, "O!:getgeraw", group_pytype
, &gobj
)) goto end
;
220 x
= G_CREATE(GROUP_G(gobj
));
221 if (G_FROMRAW(GROUP_G(gobj
), BUF_B(me
), x
)) BUFERR("buffer exhausted");
222 return (ge_pywrap(gobj
, x
));
224 if (x
) G_DESTROY(GROUP_G(gobj
), x
);
228 static PyObject
*rbget_size(PyObject
*me
, void *hunoz
)
229 { return (PyInt_FromLong(BSZ(BUF_B(me
)))); }
230 static PyObject
*rbget_left(PyObject
*me
, void *hunoz
)
231 { return (PyInt_FromLong(BLEFT(BUF_B(me
)))); }
232 static PyObject
*rbget_endp(PyObject
*me
, void *hunoz
)
233 { return (getbool(!BLEFT(BUF_B(me
)))); }
234 static PyObject
*rbget_offset(PyObject
*me
, void *hunoz
)
235 { return (PyInt_FromLong(BLEN(BUF_B(me
)))); }
236 static int rbset_offset(PyObject
*me
, PyObject
*x
, void *hunoz
)
239 if (!x
) NIERR("__del__");
240 if (!convszt(x
, &n
)) goto end
;
241 if (n
> BSZ(BUF_B(me
))) VALERR("out of range");
242 BCUR(BUF_B(me
)) = BBASE(BUF_B(me
)) + n
;
248 static const PyGetSetDef rbuf_pygetset
[] = {
249 #define GETSETNAME(op, name) rb##op##_##name
250 GET (size
, "RBUF.size -> SIZE")
251 GET (left
, "RBUF.left -> REMAINDER")
252 GET (endp
, "RBUF.endp -> BOOL")
253 GETSET(offset
, "RBUF.offset -> OFFSET")
258 static const PyMethodDef rbuf_pymethods
[] = {
259 #define METHNAME(func) rbmeth_##func
260 METH (skip
, "RBUF.skip(N)")
261 METH (get
, "RBUF.get(N) -> BYTES")
262 #define RBMETH_DECL_GETU_(n, W, w) \
263 METH(getu##w, "RBUF.getu" #w "() -> INT")
264 DOUINTCONV(RBMETH_DECL_GETU_
)
265 #define RBMETH_DECL_GETBLK_(n, W, w) \
266 METH(getblk##w, "RBUF.getblk" #w "() -> BYTES")
267 BUF_DOSUFFIXES(RBMETH_DECL_GETBLK_
)
268 #define RBMETH_DECL_GETBUF_(n, W, w) \
269 METH(getbuf##w, "RBUF.getbuf" #w "() -> RBUF'")
270 BUF_DOSUFFIXES(RBMETH_DECL_GETBUF_
)
271 METH (getmp
, "RBUF.getmp() -> X")
272 METH (getgf
, "RBUF.getgf() -> X")
273 KWMETH(getecpt
, "RBUF.getecpt([curve = None]) -> P")
274 METH (getecptraw
, "RBUF.getecptraw(CURVE) -> P")
275 METH (getge
, "RBUF.getge(GROUP) -> X")
276 METH (getgeraw
, "RBUF.getgeraw(GROUP) -> X")
281 static const PyBufferProcs rbuf_pybuffer
= {
282 rbuf_pyreadbuf
, /* @bf_getreadbuffer@ */
283 0, /* @bf_getwritebuffer@ */
284 rbuf_pysegcount
, /* @bf_getsegcount@ */
285 0 /* @bf_getcharbuffer@ */
288 static PyTypeObject rbuf_pytype_skel
= {
289 PyObject_HEAD_INIT(0) 0, /* Header */
290 "ReadBuffer", /* @tp_name@ */
291 sizeof(buf_pyobj
), /* @tp_basicsize@ */
292 0, /* @tp_itemsize@ */
294 buf_pydealloc
, /* @tp_dealloc@ */
296 0, /* @tp_getattr@ */
297 0, /* @tp_setattr@ */
298 0, /* @tp_compare@ */
300 0, /* @tp_as_number@ */
301 0, /* @tp_as_sequence@ */
302 0, /* @tp_as_mapping@ */
306 0, /* @tp_getattro@ */
307 0, /* @tp_setattro@ */
308 PYBUFFER(rbuf
), /* @tp_as_buffer@ */
309 Py_TPFLAGS_DEFAULT
| /* @tp_flags@ */
313 "ReadBuffer(STR): a read buffer.",
315 0, /* @tp_traverse@ */
317 0, /* @tp_richcompare@ */
318 0, /* @tp_weaklistoffset@ */
320 0, /* @tp_iternext@ */
321 PYMETHODS(rbuf
), /* @tp_methods@ */
322 0, /* @tp_members@ */
323 PYGETSET(rbuf
), /* @tp_getset@ */
326 0, /* @tp_descr_get@ */
327 0, /* @tp_descr_set@ */
328 0, /* @tp_dictoffset@ */
330 PyType_GenericAlloc
, /* @tp_alloc@ */
331 rbuf_pynew
, /* @tp_new@ */
336 /*----- Write buffers -----------------------------------------------------*/
338 static void ensure(PyObject
*me
, size_t n
)
345 size_t want
= BLEN(b
) + n
;
346 while (nn
< want
) nn
<<= 1;
347 p
= xrealloc(BBASE(b
), nn
, BSZ(b
));
348 BCUR(b
) = p
+ BLEN(b
);
354 static PyObject
*wbuf_pynew(PyTypeObject
*ty
, PyObject
*arg
, PyObject
*kw
)
359 static const char *const kwlist
[] = { "size", 0 };
361 if (!PyArg_ParseTupleAndKeywords(arg
, kw
, "|O&:new", KWLIST
,
364 me
= (buf_pyobj
*)ty
->tp_alloc(ty
, 0);
367 buf_init(&me
->b
, p
, n
);
369 return ((PyObject
*)me
);
372 static Py_ssize_t
wbuf_pysegcount(PyObject
*me
, Py_ssize_t
*nn
)
373 { if (nn
) *nn
= BLEN(BUF_B(me
)); return (1); }
375 static Py_ssize_t
wbuf_pyreadbuf(PyObject
*me
, Py_ssize_t seg
, void **q
)
376 { assert(seg
== 0); *q
= BBASE(BUF_B(me
)); return (BLEN(BUF_B(me
))); }
378 static PyObject
*wbmeth_zero(PyObject
*me
, PyObject
*arg
)
382 if (!PyArg_ParseTuple(arg
, "O&:zero", convszt
, &n
)) return (0);
384 p
= buf_get(BUF_B(me
), n
); assert(p
&& BOK(BUF_B(me
)));
389 static PyObject
*wbmeth_put(PyObject
*me
, PyObject
*arg
)
393 if (!PyArg_ParseTuple(arg
, "s#:put", &p
, &n
)) return (0);
395 buf_put(BUF_B(me
), p
, n
); assert(BOK(BUF_B(me
)));
399 #define WBMETH_PUTU_(n, W, w) \
400 static PyObject *wbmeth_putu##w(PyObject *me, PyObject *arg) \
403 if (!PyArg_ParseTuple(arg, "O&:putu" #w, convu##n, &i)) return (0); \
404 ensure(me, SZ_##n); \
405 buf_putu##w(BUF_B(me), i); assert(BOK(BUF_B(me))); \
408 DOUINTCONV(WBMETH_PUTU_
)
412 #define WBMETH_PUTBLK_(n, W, w) \
413 static PyObject *wbmeth_putblk##w(PyObject *me, PyObject *arg) \
417 if (!PyArg_ParseTuple(arg, "s#:putblk" #w, &p, &sz)) goto end; \
418 if (MASK##W && sz > MASK##W) VALERR("too large"); \
419 ensure(me, sz + SZ_##n); \
420 buf_putmem##w(BUF_B(me), p, sz); assert(BOK(BUF_B(me))); \
425 BUF_DOSUFFIXES(WBMETH_PUTBLK_
)
427 static PyObject
*wbmeth_putmp(PyObject
*me
, PyObject
*arg
)
430 if (!PyArg_ParseTuple(arg
, "O&:putmp", convmp
, &x
)) return (0);
431 ensure(me
, mp_octets(x
) + 2);
432 buf_putmp(BUF_B(me
), x
); assert(BOK(BUF_B(me
)));
436 static PyObject
*wbmeth_putgf(PyObject
*me
, PyObject
*arg
)
439 if (!PyArg_ParseTuple(arg
, "O&:putgf", convgf
, &x
)) return (0);
440 ensure(me
, mp_octets(x
) + 2);
441 buf_putmp(BUF_B(me
), x
); assert(BOK(BUF_B(me
)));
446 static PyObject
*wbmeth_putecpt(PyObject
*me
, PyObject
*arg
)
449 if (!PyArg_ParseTuple(arg
, "O&:putecpt", convecpt
, &pt
)) return (0);
450 ensure(me
, EC_ATINF(&pt
) ?
2 : 6 + mp_octets(pt
.x
) + mp_octets(pt
.y
));
451 buf_putec(BUF_B(me
), &pt
); assert(BOK(BUF_B(me
)));
456 static PyObject
*wbmeth_putecptraw(PyObject
*me
, PyObject
*arg
)
460 if (!PyArg_ParseTuple(arg
, "O!:putecptraw", ecptcurve_pytype
, &ptobj
))
462 EC_OUT(ECPT_C(ptobj
), &pt
, ECPT_P(ptobj
));
463 ensure(me
, ECPT_C(ptobj
)->f
->noctets
* 2 + 1);
464 ec_putraw(ECPT_C(ptobj
), BUF_B(me
), &pt
); assert(BOK(BUF_B(me
)));
469 static PyObject
*wbmeth_putge(PyObject
*me
, PyObject
*arg
)
472 if (!PyArg_ParseTuple(arg
, "O!:putge", ge_pytype
, &geobj
)) return (0);
473 ensure(me
, GE_G(geobj
)->noctets
);
474 G_TOBUF(GE_G(geobj
), BUF_B(me
), GE_X(geobj
)); assert(BOK(BUF_B(me
)));
478 static PyObject
*wbmeth_putgeraw(PyObject
*me
, PyObject
*arg
)
481 if (!PyArg_ParseTuple(arg
, "O!:putgeraw", ge_pytype
, &geobj
)) return (0);
482 ensure(me
, GE_G(geobj
)->noctets
);
483 G_TORAW(GE_G(geobj
), BUF_B(me
), GE_X(geobj
)); assert(BOK(BUF_B(me
)));
487 static PyObject
*wbget_size(PyObject
*me
, void *hunoz
)
488 { return (PyInt_FromLong(BLEN(BUF_B(me
)))); }
490 static PyObject
*wbget_contents(PyObject
*me
, void *hunoz
)
491 { return (bytestring_pywrap(BBASE(BUF_B(me
)), BLEN(BUF_B(me
)))); }
493 static const PyGetSetDef wbuf_pygetset
[] = {
494 #define GETSETNAME(op, name) wb##op##_##name
495 GET (size
, "WBUF.size -> SIZE")
496 GET (contents
, "WBUF.contents -> STR")
501 static const PyMethodDef wbuf_pymethods
[] = {
502 #define METHNAME(func) wbmeth_##func
503 METH (zero
, "WBUF.zero(N)")
504 METH (put
, "WBUF.put(BYTES)")
505 #define WBMETH_DECL_PUTU_(n, W, w) \
506 METH(putu##w, "WBUF.putu" #w "(INT)")
507 DOUINTCONV(WBMETH_DECL_PUTU_
)
508 #define WBMETH_DECL_PUTBLK_(n, W, w) \
509 METH(putblk##w, "WBUF.putblk" #w "(BYTES)")
510 BUF_DOSUFFIXES(WBMETH_DECL_PUTBLK_
)
511 METH (putmp
, "WBUF.putmp(X)")
512 METH (putgf
, "WBUF.putgf(X)")
513 METH (putecpt
, "WBUF.putecpt(P)")
514 METH (putecptraw
, "WBUF.putecptraw(P)")
515 METH (putge
, "WBUF.putge(X)")
516 METH (putgeraw
, "WBUF.putgeraw(X)")
521 static const PyBufferProcs wbuf_pybuffer
= {
522 wbuf_pyreadbuf
, /* @bf_getreadbuffer@ */
523 0, /* @bf_getwritebuffer@ */
524 wbuf_pysegcount
, /* @bf_getsegcount@ */
525 0 /* @bf_getcharbuffer@ */
528 static PyTypeObject wbuf_pytype_skel
= {
529 PyObject_HEAD_INIT(0) 0, /* Header */
530 "WriteBuffer", /* @tp_name@ */
531 sizeof(buf_pyobj
), /* @tp_basicsize@ */
532 0, /* @tp_itemsize@ */
534 buf_pydealloc
, /* @tp_dealloc@ */
536 0, /* @tp_getattr@ */
537 0, /* @tp_setattr@ */
538 0, /* @tp_compare@ */
540 0, /* @tp_as_number@ */
541 0, /* @tp_as_sequence@ */
542 0, /* @tp_as_mapping@ */
546 0, /* @tp_getattro@ */
547 0, /* @tp_setattro@ */
548 PYBUFFER(wbuf
), /* @tp_as_buffer@ */
549 Py_TPFLAGS_DEFAULT
| /* @tp_flags@ */
553 "WriteBuffer([size = ?]): a write buffer.",
555 0, /* @tp_traverse@ */
557 0, /* @tp_richcompare@ */
558 0, /* @tp_weaklistoffset@ */
560 0, /* @tp_iternext@ */
561 PYMETHODS(wbuf
), /* @tp_methods@ */
562 0, /* @tp_members@ */
563 PYGETSET(wbuf
), /* @tp_getset@ */
566 0, /* @tp_descr_get@ */
567 0, /* @tp_descr_set@ */
568 0, /* @tp_dictoffset@ */
570 PyType_GenericAlloc
, /* @tp_alloc@ */
571 wbuf_pynew
, /* @tp_new@ */
576 /*----- Initialization ----------------------------------------------------*/
578 void buffer_pyinit(void)
580 INITTYPE(rbuf
, root
);
581 INITTYPE(wbuf
, root
);
584 void buffer_pyinsert(PyObject
*mod
)
586 INSEXC("BufferError", buferr
, PyExc_Exception
, 0);
587 INSERT("ReadBuffer", rbuf_pytype
);
588 INSERT("WriteBuffer", wbuf_pytype
);
591 /*----- That's all, folks -------------------------------------------------*/