summaryrefslogtreecommitdiffstats
path: root/python/samba/tests/krb5/rfc4120_pyasn1.py
blob: ad8a6e7b6dbb3a0ac9b0a71abb46b9b66b0678cf (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
# Unix SMB/CIFS implementation.
# Copyright (C) Catalyst.Net Ltd 2023
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
#

from samba.tests.krb5.rfc4120_pyasn1_generated import *

# Kerberos strings should generally be treated as UTF‐8 encoded, but asn1ate
# (the tool which generates Python definitions from our ASN.1 modules) provides
# no way to specify the encoding to use. By the time we’ve imported
# ‘rfc4120_pyasn1_generated’, KerberosString in the process having been
# instantiated as part of several schema objects, it’s too late to change the
# existing objects. But by overriding the __getattribute__() method on
# KerberosString, we can have objects of that type, or a subtype thereof,
# encoded as UTF‐8 strings instead of as ISO-8859-1 strings (the default).

class ReadOnlyUtf8EncodingDict(dict):
    # Don’t allow any attributes to be set.
    __slots__ = []

    def __getitem__(self, key):
        # Get the original item. This will raise KeyError if it’s not present.
        val = super().__getitem__(key)

        # If anyone wants to know our encoding, say it’s UTF‐8.
        if key == 'encoding':
            return 'utf-8'

        return val

    # Python’s default implementations of the following methods don’t call
    # __getitem__(), so we’ll need to override them with our own replacements.
    # In behaviour, they are close enough to the originals for our purposes.

    def get(self, key, default=None):
        try:
            return self[key]
        except KeyError:
            return default

    def items(self):
        for key in self:
            yield key, self[key]

    def values(self):
        for key in self:
            yield self[key]

    # Don’t let anyone modify the dict’s contents.

    def __setitem__(self, key, val):
        raise TypeError('item assignment not supported')

    def __delitem__(self, key):
        raise TypeError('item deletion not supported')


KerberosString_get_attribute = KerberosString.__getattribute__

def get_attribute_override(self, attr):
    # Get the original attribute. This will raise AttributeError if it’s not
    # present.
    val = KerberosString_get_attribute(self, attr)

    # If anyone wants to know our encoding, say it’s UTF‐8.
    if attr == 'encoding':
        return 'utf-8'

    if attr == '_readOnly':
        # Return a copy of the read‐only attributes with the encoding overridden
        # to be UTF-8. To avoid the possibility of changes being made to the
        # original dict that do not propagate to its copies, the returned dict
        # does not allow modification of its contents. Besides, this is supposed
        # to be read‐only.
        return ReadOnlyUtf8EncodingDict(val)

    return val

# Override the __getattribute__() method on KerberosString.
KerberosString.__getattribute__ = get_attribute_override