summaryrefslogtreecommitdiffstats
path: root/python/hashstring.cc
blob: 01f14a08809010220f8094acef07052ec11a55a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/* hashstring.cc - Wrapper around HashString
 *
 * Copyright 2009 Julian Andres Klode <jak@debian.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */
#include <Python.h>
#include "generic.h"
#include "apt_pkgmodule.h"
#include <apt-pkg/hashes.h>

static PyObject *hashstring_new(PyTypeObject *type,PyObject *Args,
                                PyObject *kwds)
{
    char *Type = NULL;
    char *Hash = NULL;
    char *kwlist[] = {"type", "hash",  NULL};
    if (PyArg_ParseTupleAndKeywords(Args, kwds, "s|s:__new__", kwlist, &Type,
                                    &Hash) == 0)
        return 0;
    CppPyObject<HashString*> *PyObj = CppPyObject_NEW<HashString*>(NULL, type);
    if (Hash)
        PyObj->Object = new HashString(Type,Hash);
    else // Type is the combined form now (i.e. type:hash)
        PyObj->Object = new HashString(Type);
    return PyObj;
}

static PyObject *hashstring_repr(PyObject *self)
{
    HashString *hash = GetCpp<HashString*>(self);
    return PyString_FromFormat("<%s object: \"%s\">", self->ob_type->tp_name,
                               hash->toStr().c_str());
}

static PyObject *hashstring_str(PyObject *self)
{
    const HashString *hash = GetCpp<HashString*>(self);
    return CppPyString(hash->toStr());
}

static PyObject *hashstring_get_hashtype(PyObject *self)
{
    const HashString *hash = GetCpp<HashString*>(self);
    return CppPyString(hash->HashType());
}

static PyObject *hashstring_get_usable(PyObject *self)
{
    const HashString *hash = GetCpp<HashString*>(self);
    return PyBool_FromLong(hash->usable());
}

static PyObject *hashstring_get_hashvalue(PyObject *self)
{
    const HashString *hash = GetCpp<HashString*>(self);
    return CppPyString(hash->HashValue());
}

static char *hashstring_verify_file_doc =
    "verify_file(filename: str) -> bool\n\n"
    "Verify that the file indicated by filename matches the hash.";

static PyObject *hashstring_verify_file(PyObject *self,PyObject *args)
{
    const HashString *hash = GetCpp<HashString*>(self);
    char *filename;
    if (PyArg_ParseTuple(args, "s:verify_file", &filename) == 0)
        return 0;
    return PyBool_FromLong(hash->VerifyFile(filename));
}

static PyMethodDef hashstring_methods[] = {
    {"verify_file",hashstring_verify_file,METH_VARARGS,
     hashstring_verify_file_doc},
    {NULL}
};

static PyGetSetDef hashstring_getset[] = {
    {"hashtype",(getter)hashstring_get_hashtype,0,
     "The type of the hash, as a string (possible: MD5Sum,SHA1,SHA256)."},
    {"hashvalue",(getter)hashstring_get_hashvalue,0,
     "The value of the hash, as a hexadecimal string\n"
     "\n"
     ".. versionadded:: 1.9.0"},
    {"usable",(getter)hashstring_get_usable,0,
     "True if the hashstring is a trusted hash type."},
    {NULL}
};

static PyObject *hashstring_richcompare(PyObject *obj1, PyObject *obj2, int op)
{
    if (!PyObject_TypeCheck(obj1, &PyHashString_Type))
        return PyErr_SetString(PyExc_TypeError, "Expected HashString"), nullptr;
    if (!PyObject_TypeCheck(obj2, &PyHashString_Type))
        return PyErr_SetString(PyExc_TypeError, "Expected HashString"), nullptr;

    const HashString *a = GetCpp<HashString*>(obj1);
    const HashString *b = GetCpp<HashString*>(obj2);
    PyObject *result = Py_False;

    switch (op) {
    case Py_LT:
    case Py_GT:
        result = Py_False;
        break;
    case Py_LE:
    case Py_GE:
    case Py_EQ:
        result = *a == *b ? Py_True : Py_False;
        break;
    case Py_NE:
        result = *a != *b ? Py_True : Py_False;
        break;
    }

    Py_INCREF(result);
    return result;
 }

static char *hashstring_doc =
    "HashString(type, hash) OR HashString('type:hash')\n\n"
    "Create a new HashString object. The first form allows you to specify\n"
    "a type and a hash, and the second form a single string where type and\n"
    "hash are separated by a colon, e.g.::\n\n"
    "   HashString('MD5Sum', '6cc1b6e6655e3555ac47e5b5fe26d04e')\n\n"
    "Valid options for 'type' are: MD5Sum, SHA1, SHA256.";
PyTypeObject PyHashString_Type = {
    PyVarObject_HEAD_INIT(&PyType_Type, 0)
    "apt_pkg.HashString",              // tp_name
    sizeof(CppPyObject<HashString*>),  // tp_basicsize
    0,                                 // tp_itemsize
    // Methods
    CppDeallocPtr<HashString*>,        // tp_dealloc
    0,                                 // tp_print
    0,                                 // tp_getattr
    0,                                 // tp_setattr
    0,                                 // tp_compare
    hashstring_repr,                   // tp_repr
    0,                                 // tp_as_number
    0,                                 // tp_as_sequence
    0,                                 // tp_as_mapping
    0,                                 // tp_hash
    0,                                 // tp_call
    hashstring_str,                    // tp_str
    0,                                 // tp_getattro
    0,                                 // tp_setattro
    0,                                 // tp_as_buffer
    Py_TPFLAGS_DEFAULT |               // tp_flags
    Py_TPFLAGS_BASETYPE,
    hashstring_doc,                    // tp_doc
    0,                                 // tp_traverse
    0,                                 // tp_clear
    hashstring_richcompare,            // tp_richcompare
    0,                                 // tp_weaklistoffset
    0,                                 // tp_iter
    0,                                 // tp_iternext
    hashstring_methods,                // tp_methods
    0,                                 // tp_members
    hashstring_getset,                 // tp_getset
    0,                                 // tp_base
    0,                                 // tp_dict
    0,                                 // tp_descr_get
    0,                                 // tp_descr_set
    0,                                 // tp_dictoffset
    0,                                 // tp_init
    0,                                 // tp_alloc
    hashstring_new,                    // tp_new
};