python/samba/ndr.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Unix SMB/CIFS implementation.
   4 # Copyright © Jelmer Vernooij <jelmer@samba.org> 2008
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19
  20
  21 """Network Data Representation (NDR) marshalling and unmarshalling."""
  22
  23
  24 def ndr_pack(object):
  25     """Pack a NDR object.
  26
  27     :param object: Object to pack
  28     :return: String object with marshalled object.
  29     """
  30     ndr_pack = getattr(object, "__ndr_pack__", None)
  31     if ndr_pack is None:
  32         raise TypeError("%r is not a NDR object" % object)
  33     return ndr_pack()
  34
  35
  36 def ndr_unpack(cls, data, allow_remaining=False):
  37     """NDR unpack an object.
  38
  39     :param cls: Class of the object to unpack
  40     :param data: Buffer to unpack
  41     :param allow_remaining: allows remaining data at the end (default=False)
  42     :return: Unpacked object
  43     """
  44     object = cls()
  45     object.__ndr_unpack__(data, allow_remaining=allow_remaining)
  46     return object
  47
  48
  49 def ndr_print(object):
  50     return object.__ndr_print__()