|
25 | 25 | """Sysctl jail params signeton."""
|
26 | 26 | import typing
|
27 | 27 | import freebsd_sysctl
|
| 28 | +import freebsd_sysctl.types |
28 | 29 | import collections.abc
|
| 30 | +import shlex |
29 | 31 |
|
30 |
| -class HostJailParams(collections.abc.MutableMapping): |
31 |
| - __params: typing.Dict[str, freebsd_sysctl.Sysctl] |
| 32 | +import libioc.helpers |
| 33 | + |
| 34 | +JailParamValueType = typing.Optional[typing.Union[bool, int, str]] |
| 35 | + |
| 36 | + |
| 37 | +class JailParam(freebsd_sysctl.Sysctl): |
| 38 | + """Single jail parameter represented by sysctl.""" |
| 39 | + |
| 40 | + user_value: JailParamValueType |
| 41 | + |
| 42 | + @property |
| 43 | + def value(self) -> JailParamValueType: |
| 44 | + """Return the user defined value of this jail parameter.""" |
| 45 | + return self.user_value |
| 46 | + |
| 47 | + @value.setter |
| 48 | + def value(self, value: JailParamValueType) -> None: |
| 49 | + """Set the user defined value of this jail parameter.""" |
| 50 | + if self.ctl_type == freebsd_sysctl.types.NODE: |
| 51 | + raise TypeError("sysctl NODE has no value") |
| 52 | + elif self.ctl_type in [ |
| 53 | + freebsd_sysctl.types.STRING, |
| 54 | + freebsd_sysctl.types.OPAQUE, |
| 55 | + ]: |
| 56 | + if (isinstance(value, int) or isinstance(value, str)) is False: |
| 57 | + try: |
| 58 | + value = str(value) |
| 59 | + except Exception: |
| 60 | + self.__raise_value_type_error() |
| 61 | + else: |
| 62 | + if (isinstance(value, int) or isinstance(value, bool)) is False: |
| 63 | + try: |
| 64 | + value = int(value) # noqa: T484 |
| 65 | + except Exception: |
| 66 | + self.__raise_value_type_error() |
| 67 | + self.user_value = value |
| 68 | + |
| 69 | + @property |
| 70 | + def sysctl_value(self) -> JailParamValueType: |
| 71 | + """Return the original freebsd_sysctl.Sysctl value.""" |
| 72 | + return typing.cast( |
| 73 | + JailParamValueType, |
| 74 | + super().value |
| 75 | + ) |
| 76 | + |
| 77 | + def __raise_value_type_error(self) -> None: |
| 78 | + type_name = self.ctl_type.__name__ |
| 79 | + raise TypeError(f"{self.name} sysctl requires {type_name}") |
| 80 | + |
| 81 | + @property |
| 82 | + def jail_arg_name(self) -> str: |
| 83 | + """Return the name of the param formatted for the jail command.""" |
| 84 | + name = str(self.name) |
| 85 | + prefix = "security.jail.param." |
| 86 | + if name.startswith(prefix) is True: |
| 87 | + return name[len(prefix):] |
| 88 | + return name |
| 89 | + |
| 90 | + @property |
| 91 | + def iocage_name(self) -> str: |
| 92 | + """Return the name of the param formatted for iocage config.""" |
| 93 | + return self.jail_arg_name.replace(".", "_") |
| 94 | + |
| 95 | + def __str__(self) -> str: |
| 96 | + """Return the jail command argument notation of the param.""" |
| 97 | + if (self.value is None): |
| 98 | + return self.jail_arg_name |
| 99 | + |
| 100 | + if (self.ctl_type == freebsd_sysctl.types.STRING): |
| 101 | + escaped_value = shlex.quote(str(self.value)) |
| 102 | + return f"{self.jail_arg_name}={escaped_value}" |
| 103 | + |
| 104 | + mapped_value = str(libioc.helpers.to_string( |
| 105 | + self.value, |
| 106 | + true="1", |
| 107 | + false="0" |
| 108 | + )) |
| 109 | + return f"{self.jail_arg_name}={mapped_value}" |
| 110 | + |
| 111 | + |
| 112 | +class JailParams(collections.abc.MutableMapping): |
| 113 | + """Collection of jail parameters.""" |
| 114 | + |
| 115 | + __base_class = JailParam |
| 116 | + __sysrc_params: typing.Dict[str, freebsd_sysctl.Sysctl] |
32 | 117 |
|
33 | 118 | def __iter__(self) -> typing.Iterator[str]:
|
34 | 119 | """Iterate over the jail param names."""
|
35 |
| - yield self.memoized_params.__iter__() |
36 |
| - |
| 120 | + yield from self.memoized_params.__iter__() |
| 121 | + |
37 | 122 | def __len__(self) -> int:
|
38 | 123 | """Return the number of available jail params."""
|
39 | 124 | return self.memoized_params.__len__()
|
40 | 125 |
|
41 |
| - def items(self) -> typing.ItemsView[str, typing.Any]: |
| 126 | + def items(self) -> typing.ItemsView[str, freebsd_sysctl.Sysctl]: |
42 | 127 | """Iterate over the keys and values."""
|
43 |
| - return typing.cast( |
44 |
| - typing.ItemsView[str, typing.Any], |
45 |
| - self.memoized_params.items() |
46 |
| - ) |
| 128 | + return self.memoized_params.items() |
47 | 129 |
|
48 | 130 | def keys(self) -> typing.KeysView[str]:
|
49 | 131 | """Return a list of all jail param names."""
|
50 |
| - return collections.abc.KeysView(*list(self.__iter__())) # noqa: T484 |
| 132 | + return collections.abc.KeysView(list(self.__iter__())) # noqa: T484 |
51 | 133 |
|
52 | 134 | def __getitem__(self, key: str) -> typing.Any:
|
53 | 135 | """Set of jail params sysrc is not implemented."""
|
54 | 136 | return self.memoized_params.__getitem__(key)
|
55 | 137 |
|
56 | 138 | def __setitem__(self, key: str, value: typing.Any) -> None:
|
57 | 139 | """Set of jail params sysrc is not supportes."""
|
58 |
| - raise NotImplementedError("jail param sysctl cannot be modified") |
| 140 | + self.memoized_params.__setitem__(key, value) |
59 | 141 |
|
60 |
| - def __delitem__(self, key: str, value: typing.Any) -> None: |
| 142 | + def __delitem__(self, key: str) -> None: |
61 | 143 | """Delete of jail param sysrc not supported."""
|
62 |
| - raise NotImplementedError("jail param sysctl cannot be deleted") |
| 144 | + self.memoized_params.__delitem__(key) |
63 | 145 |
|
64 | 146 | @property
|
65 | 147 | def memoized_params(self) -> typing.Dict[str, freebsd_sysctl.Sysctl]:
|
| 148 | + """Return the memorized params initialized on first access.""" |
66 | 149 | try:
|
67 |
| - return self.__params |
| 150 | + return self.__sysrc_params |
68 | 151 | except AttributeError:
|
69 | 152 | pass
|
70 | 153 | self.__update_sysrc_jail_params()
|
71 |
| - return self.__params |
| 154 | + return self.__sysrc_params |
72 | 155 |
|
73 | 156 | def __update_sysrc_jail_params(self) -> None:
|
74 | 157 | prefix = "security.jail.param"
|
75 | 158 | jail_params = filter(
|
76 |
| - lambda x: x.name.endswith(".") is False, # filter NODE |
77 |
| - freebsd_sysctl.Sysctl(prefix).children |
78 |
| - ) |
79 |
| - HostJailParams.__params = dict( |
80 |
| - [(x.name[len(prefix) + 1:], x,) for x in jail_params] |
| 159 | + lambda x: not any(( |
| 160 | + x.name.endswith("."), # quick filter NODE |
| 161 | + x.name == "security.jail.allow_raw_sockets", # deprecated |
| 162 | + )), |
| 163 | + self.__base_class(prefix).children |
81 | 164 | )
|
| 165 | + # permanently store the queried sysrc in the singleton class |
| 166 | + JailParams.__sysrc_params = dict([(x.name, x,) for x in jail_params]) |
| 167 | + |
| 168 | + |
| 169 | +class HostJailParams(JailParams): |
| 170 | + """Read-only host jail parameters obtained from sysrc.""" |
| 171 | + |
| 172 | + __base_class = freebsd_sysctl.Sysctl |
| 173 | + |
| 174 | + def __setitem__(self, key: str, value: typing.Any) -> None: |
| 175 | + """Set of jail params sysrc is not supportes.""" |
| 176 | + raise NotImplementedError("jail param sysctl cannot be modified") |
| 177 | + |
| 178 | + def __delitem__(self, key: str) -> None: |
| 179 | + """Delete of jail param sysrc not supported.""" |
| 180 | + raise NotImplementedError("jail param sysctl cannot be deleted") |
0 commit comments