forked from python-happybase/happybase
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding Kerberos Support via TSaslClientTransport
- Added a "sasl" dependency to requirements - Added working TSaslClientTransport - 2 (optional) arguments were added to the Connection class: :use_kerberos | signals to use secure authentication :sasl_service | name of the SASL service (default: hbase)
- Loading branch information
ricky
committed
Sep 19, 2015
1 parent
9cbd718
commit 1c1e507
Showing
3 changed files
with
198 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| """ SASL transports for Thrift. """ | ||
|
|
||
| from thrift.transport.TTransport import CReadableTransport, TTransportBase, TTransportException, StringIO | ||
| import struct | ||
|
|
||
| class TSaslClientTransport(TTransportBase, CReadableTransport): | ||
| START = 1 | ||
| OK = 2 | ||
| BAD = 3 | ||
| ERROR = 4 | ||
| COMPLETE = 5 | ||
|
|
||
| def __init__(self, sasl_client_factory, mechanism, trans): | ||
| """ | ||
| @param sasl_client_factory: a callable that returns a new sasl.Client object | ||
| @param mechanism: the SASL mechanism (e.g. "GSSAPI", "PLAIN") | ||
| @param trans: the underlying transport over which to communicate. | ||
| """ | ||
| self._trans = trans | ||
| self.sasl_client_factory = sasl_client_factory | ||
| self.sasl = None | ||
| self.mechanism = mechanism | ||
| self.__wbuf = StringIO() | ||
| self.__rbuf = StringIO() | ||
| self.opened = False | ||
| self.encode = None | ||
|
|
||
| def isOpen(self): | ||
| return self._trans.isOpen() | ||
|
|
||
| def open(self): | ||
| if not self._trans.isOpen(): | ||
| self._trans.open() | ||
|
|
||
| if self.sasl is not None: | ||
| raise TTransportException( | ||
| type=TTransportException.NOT_OPEN, | ||
| message="Already open!") | ||
| self.sasl = self.sasl_client_factory | ||
|
|
||
| ret, chosen_mech, initial_response = self.sasl.start(self.mechanism) | ||
| if not ret: | ||
| raise TTransportException(type=TTransportException.NOT_OPEN, | ||
| message=("Could not start SASL: %s" % self.sasl.getError())) | ||
|
|
||
| # Send initial response | ||
| self._send_message(self.START, chosen_mech) | ||
| self._send_message(self.OK, initial_response) | ||
|
|
||
| # SASL negotiation loop | ||
| while True: | ||
| status, payload = self._recv_sasl_message() | ||
| if status not in (self.OK, self.COMPLETE): | ||
| raise TTransportException(type=TTransportException.NOT_OPEN, | ||
| message=("Bad status: %d (%s)" % (status, payload))) | ||
| if status == self.COMPLETE: | ||
| break | ||
| ret, response = self.sasl.step(payload) | ||
| if not ret: | ||
| raise TTransportException(type=TTransportException.NOT_OPEN, | ||
| message=("Bad SASL result: %s" % (self.sasl.getError()))) | ||
| self._send_message(self.OK, response) | ||
|
|
||
| def _send_message(self, status, body): | ||
| header = struct.pack(">BI", status, len(body)) | ||
| self._trans.write(header + body) | ||
| self._trans.flush() | ||
|
|
||
| def _recv_sasl_message(self): | ||
| header = self._trans.readAll(5) | ||
| status, length = struct.unpack(">BI", header) | ||
| if length > 0: | ||
| payload = self._trans.readAll(length) | ||
| else: | ||
| payload = "" | ||
| return status, payload | ||
|
|
||
| def write(self, data): | ||
| self.__wbuf.write(data) | ||
|
|
||
| def flush(self): | ||
| buffer = self.__wbuf.getvalue() | ||
| # The first time we flush data, we send it to sasl.encode() | ||
| # If the length doesn't change, then we must be using a QOP | ||
| # of auth and we should no longer call sasl.encode(), otherwise | ||
| # we encode every time. | ||
| if self.encode == None: | ||
| success, encoded = self.sasl.encode(buffer) | ||
| if not success: | ||
| raise TTransportException(type=TTransportException.UNKNOWN, | ||
| message=self.sasl.getError()) | ||
| if (len(encoded)==len(buffer)): | ||
| self.encode = False | ||
| self._flushPlain(buffer) | ||
| else: | ||
| self.encode = True | ||
| self._trans.write(encoded) | ||
| elif self.encode: | ||
| self._flushEncoded(buffer) | ||
| else: | ||
| self._flushPlain(buffer) | ||
|
|
||
| self._trans.flush() | ||
| self.__wbuf = StringIO() | ||
|
|
||
| def _flushEncoded(self, buffer): | ||
| # sasl.ecnode() does the encoding and adds the length header, so nothing | ||
| # to do but call it and write the result. | ||
| success, encoded = self.sasl.encode(buffer) | ||
| if not success: | ||
| raise TTransportException(type=TTransportException.UNKNOWN, | ||
| message=self.sasl.getError()) | ||
| self._trans.write(encoded) | ||
|
|
||
| def _flushPlain(self, buffer): | ||
| # When we have QOP of auth, sasl.encode() will pass the input to the output | ||
| # but won't put a length header, so we have to do that. | ||
|
|
||
| # Note stolen from TFramedTransport: | ||
| # N.B.: Doing this string concatenation is WAY cheaper than making | ||
| # two separate calls to the underlying socket object. Socket writes in | ||
| # Python turn out to be REALLY expensive, but it seems to do a pretty | ||
| # good job of managing string buffer operations without excessive copies | ||
| self._trans.write(struct.pack(">I", len(buffer)) + buffer) | ||
|
|
||
| def read(self, sz): | ||
| ret = self.__rbuf.read(sz) | ||
| if len(ret) != 0: | ||
| return ret | ||
|
|
||
| self._read_frame() | ||
| return self.__rbuf.read(sz) | ||
|
|
||
| def _read_frame(self): | ||
| header = self._trans.readAll(4) | ||
| (length,) = struct.unpack(">I", header) | ||
| if self.encode: | ||
| # If the frames are encoded (i.e. you're using a QOP of auth-int or | ||
| # auth-conf), then make sure to include the header in the bytes you send to | ||
| # sasl.decode() | ||
| encoded = header + self._trans.readAll(length) | ||
| success, decoded = self.sasl.decode(encoded) | ||
| if not success: | ||
| raise TTransportException(type=TTransportException.UNKNOWN, | ||
| message=self.sasl.getError()) | ||
| else: | ||
| # If the frames are not encoded, just pass it through | ||
| decoded = self._trans.readAll(length) | ||
| self.__rbuf = StringIO(decoded) | ||
|
|
||
| def close(self): | ||
| self._trans.close() | ||
| self.sasl = None | ||
|
|
||
| # Implement the CReadableTransport interface. | ||
| # Stolen shamelessly from TFramedTransport | ||
| @property | ||
| def cstringio_buf(self): | ||
| return self.__rbuf | ||
|
|
||
| def cstringio_refill(self, prefix, reqlen): | ||
| # self.__rbuf will already be empty here because fastbinary doesn't | ||
| # ask for a refill until the previous buffer is empty. Therefore, | ||
| # we can start reading new frames immediately. | ||
| while len(prefix) < reqlen: | ||
| self._read_frame() | ||
| prefix += self.__rbuf.getvalue() | ||
| self.__rbuf = StringIO(prefix) | ||
| return self.__rbuf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| thrift>=0.8.0 | ||
| sasl |