aboutsummaryrefslogtreecommitdiff
path: root/cryptech_console
blob: 5ac12ba841cdc718b748a089f75e8bb5c2fc5d9c (plain) (blame)
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
#!/usr/bin/env python
#
# Copyright (c) 2017, NORDUnet A/S All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# - Redistributions of source code must retain the above copyright notice,
#   this list of conditions and the following disclaimer.
#
# - Redistributions in binary form must reproduce the above copyright
#   notice, this list of conditions and the following disclaimer in the
#   documentation and/or other materials provided with the distribution.
#
# - Neither the name of the NORDUnet nor the names of its contributors may
#   be used to endorse or promote products derived from this software
#   without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""
Console client shim to work with Cryptech Python multiplexer.
"""

import os
import sys
import socket
import atexit
import termios
import argparse

import tornado.iostream
import tornado.ioloop
import tornado.gen

class FemtoTerm(object):

    def __init__(self, s):
        self.termios_setup()
        self.stdin_stream  = tornado.iostream.PipeIOStream(sys.stdin.fileno())
        self.stdout_stream = tornado.iostream.PipeIOStream(sys.stdout.fileno())
        self.socket_stream = tornado.iostream.IOStream(s)
        self.closed = False

    def close(self):
        self.termios_teardown()
        self.stdin_stream.close()
        self.stdout_stream.close()
        self.socket_stream.close()
        self.closed = True

    @tornado.gen.coroutine
    def run(self):
        yield [self.stdout_loop(), self.stdin_loop()]

    def termios_setup(self):
        self.fd = sys.stdin.fileno()
        self.old_tcattr = termios.tcgetattr(self.fd)
        self.new_tcattr = termios.tcgetattr(self.fd)
        atexit.register(self.termios_teardown)
        self.new_tcattr[3] &= ~(termios.ICANON | termios.ECHO) #  | termios.ISIG
        self.new_tcattr[6][termios.VMIN] = 1
        self.new_tcattr[6][termios.VTIME] = 0
        termios.tcsetattr(self.fd, termios.TCSANOW, self.new_tcattr)

    def termios_teardown(self):
        if self.fd is not None:
            termios.tcsetattr(self.fd, termios.TCSAFLUSH, self.old_tcattr)
            self.fd = None

    @tornado.gen.coroutine
    def copy_loop(self, stream1, stream2, text1, text2, buffer_size = 1024):
        try:
            while not self.closed:
                buffer = yield stream1.read_bytes(buffer_size, partial = True)
                yield stream2.write(buffer.replace(text1, text2))
        except tornado.iostream.StreamClosedError:
            self.close()

    def stdin_loop(self):
        return self.copy_loop(self.stdin_stream, self.socket_stream, "\n", "\r")

    def stdout_loop(self):
        return self.copy_loop(self.socket_stream, self.stdout_stream, "\r\n", "\n")

def main():
    parser = argparse.ArgumentParser(formatter_class = argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument("cty_socket",
                        nargs = "?",
                        help = "CTY PF_UNIX socket name",
                        default = os.getenv("CRYPTECH_CTY_CLIENT_SOCKET_NAME",
                                            "/tmp/.cryptech_muxd.cty"))
    args = parser.parse_args()

    s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
    try:
        s.connect(args.cty_socket)
    except socket.error:
        sys.exit("Couldn't connect to socket {}".format(args.cty_socket))
    tornado.ioloop.IOLoop.current().run_sync(FemtoTerm(s).run)

if __name__ == "__main__":
    try:
        main()
    except KeyboardInterrupt:
        pass
">) cmp = ((int) name1->chunk) - ((int) name2->chunk); return cmp; } /* * Find a block in the index, return true (found) or false (not found). * "where" indicates the name's position, or the position of the first free block. * * NB: This does NOT return a block number, it returns an index into * ksi->index[]. */ static int ks_find(const hal_ks_index_t * const ksi, const hal_uuid_t * const uuid, const uint8_t chunk, const int * const hint, int *where) { assert(ksi != NULL && ksi->index != NULL && ksi->names != NULL && uuid != NULL && where != NULL); const hal_ks_name_t name = { *uuid, chunk }; if (hint != NULL && *hint >= 0 && *hint < ksi->used && ks_name_cmp(&name, &ksi->names[ksi->index[*hint]]) == 0) { *where = *hint; return 1; } int lo = -1; int hi = ksi->used; for (;;) { int m = (lo + hi) / 2; if (hi == 0 || m == lo) { *where = hi; return 0; } const int cmp = ks_name_cmp(&name, &ksi->names[ksi->index[m]]); if (cmp < 0) hi = m; else if (cmp > 0) lo = m; else { *where = m; return 1; } } } /* * Heapsort the index. We only need to do this on setup, for other * operations we're just inserting or deleting a single entry in an * already-ordered array, which is just a search problem. If we were * really crunched for space, we could use an insertion sort here, but * heapsort is easy and works well with data already in place. */ static inline void ks_heapsift(hal_ks_index_t *ksi, int parent, const int end) { assert(ksi != NULL && ksi->index != NULL && ksi->names != NULL && parent >= 0 && end >= parent); for (;;) { const int left_child = parent * 2 + 1; const int right_child = parent * 2 + 2; int biggest = parent; if (left_child <= end && ks_name_cmp(&ksi->names[ksi->index[biggest]], &ksi->names[ksi->index[left_child]]) < 0) biggest = left_child; if (right_child <= end && ks_name_cmp(&ksi->names[ksi->index[biggest]], &ksi->names[ksi->index[right_child]]) < 0) biggest = right_child; if (biggest == parent) return; const uint16_t tmp = ksi->index[biggest]; ksi->index[biggest] = ksi->index[parent]; ksi->index[parent] = tmp; parent = biggest; } } static inline void ks_heapsort(hal_ks_index_t *ksi) { assert(ksi != NULL && ksi->index != NULL && ksi->names != NULL); if (ksi->used < 2) return; for (int i = (ksi->used - 2) / 2; i >= 0; i--) ks_heapsift(ksi, i, ksi->used - 1); for (int i = ksi->used - 1; i > 0; i--) { const uint16_t tmp = ksi->index[i]; ksi->index[i] = ksi->index[0]; ksi->index[0] = tmp; ks_heapsift(ksi, 0, i - 1); } } /* * Perform a consistency check on the index. */ #define fsck(_ksi) \ do { hal_error_t _err = hal_ks_index_fsck(_ksi); if (_err != HAL_OK) return _err; } while (0) hal_error_t hal_ks_index_fsck(hal_ks_index_t *ksi) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size) return HAL_ERROR_BAD_ARGUMENTS; for (int i = 0; i < ksi->used; i++) { const int cmp = i == 0 ? -1 : hal_uuid_cmp(&ksi->names[ksi->index[i - 1]].name, &ksi->names[ksi->index[i ]].name); const uint8_t prev_chunk = i == 0 ? 0 : ksi->names[ksi->index[i - 1]].chunk; const uint8_t cur_chunk = ksi->names[ksi->index[i ]].chunk; if (cmp > 0) return HAL_ERROR_KSI_INDEX_UUID_MISORDERED; if (cur_chunk > 0 && cmp != 0) return HAL_ERROR_KSI_INDEX_CHUNK_ORPHANED; if (cur_chunk > 0 && prev_chunk + 1 < cur_chunk) return HAL_ERROR_KSI_INDEX_CHUNK_MISSING; if (cur_chunk > 0 && prev_chunk + 1 > cur_chunk) return HAL_ERROR_KSI_INDEX_CHUNK_OVERLAPS; } return HAL_OK; } /* * Set up the index. Only setup task we have at the moment is sorting the index. */ hal_error_t hal_ks_index_setup(hal_ks_index_t *ksi) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size) return HAL_ERROR_BAD_ARGUMENTS; ks_heapsort(ksi); /* * One might think we should fsck here, but errors in the index * at this point probably relate to errors in the supplied data, * which only the driver knows how to clean up. */ return HAL_OK; } /* * Find a single block by name and chunk number. */ hal_error_t hal_ks_index_find(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned chunk, unsigned *blockno, int *hint) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; int where; fsck(ksi); int ok = ks_find(ksi, name, chunk, hint, &where); if (blockno != NULL) *blockno = ksi->index[where]; if (hint != NULL) *hint = where; return ok ? HAL_OK : HAL_ERROR_KEY_NOT_FOUND; } /* * Find all blocks with the given name. * If 'strict' is set, expect it to be a well-ordered set of chunks. */ hal_error_t hal_ks_index_find_range(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned max_blocks, unsigned *n_blocks, unsigned *blocknos, int *hint, const int strict) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; int where; fsck(ksi); if (!ks_find(ksi, name, 0, hint, &where)) return HAL_ERROR_KEY_NOT_FOUND; int n = 0; for (int i = where; i < ksi->used && !hal_uuid_cmp(name, &ksi->names[ksi->index[i]].name); i++) { if (strict && n != ksi->names[ksi->index[i]].chunk) return HAL_ERROR_IMPOSSIBLE; if (blocknos != NULL && n < max_blocks) blocknos[n] = ksi->index[i]; n++; } if (n_blocks != NULL) *n_blocks = n; if (hint != NULL) *hint = where; if (blocknos != NULL && n > max_blocks) return HAL_ERROR_RESULT_TOO_LONG; return HAL_OK; } /* * Add a single block to the index. */ hal_error_t hal_ks_index_add(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned chunk, unsigned *blockno, int *hint) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; if (ksi->used == ksi->size) return HAL_ERROR_NO_KEY_INDEX_SLOTS; int where; fsck(ksi); if (ks_find(ksi, name, chunk, hint, &where)) return HAL_ERROR_KEY_NAME_IN_USE; /* * Grab first block on free list, which makes room to slide the * index up by one slot so we can insert the new block number. */ const size_t len = (ksi->used - where) * sizeof(*ksi->index); const uint16_t b = ksi->index[ksi->used++]; memmove(&ksi->index[where + 1], &ksi->index[where], len); ksi->index[where] = b; ksi->names[b].name = *name; ksi->names[b].chunk = chunk; if (blockno != NULL) *blockno = b; if (hint != NULL) *hint = where; fsck(ksi); return HAL_OK; } /* * Delete a single block from the index. */ hal_error_t hal_ks_index_delete(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned chunk, unsigned *blockno, int *hint) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; int where; fsck(ksi); if (ksi->used == 0 || !ks_find(ksi, name, chunk, hint, &where)) return HAL_ERROR_KEY_NOT_FOUND; /* * Free the block and stuff it at the end of the free list. */ const size_t len = (ksi->size - where - 1) * sizeof(*ksi->index); const uint16_t b = ksi->index[where]; memmove(&ksi->index[where], &ksi->index[where + 1], len); ksi->index[ksi->size - 1] = b; ksi->used--; memset(&ksi->names[b], 0, sizeof(ksi->names[b])); if (blockno != NULL) *blockno = b; if (hint != NULL) *hint = where; fsck(ksi); return HAL_OK; } /* * Delete all blocks with the given name. If blocknos is NULL, return a * count of the matching blocks without deleting anything. */ hal_error_t hal_ks_index_delete_range(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned max_blocks, unsigned *n_blocks, unsigned *blocknos, int *hint) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; int where; fsck(ksi); if (ksi->used == 0 || !ks_find(ksi, name, 0, hint, &where)) return HAL_ERROR_KEY_NOT_FOUND; int n = 0; for (int i = where; i < ksi->used && !hal_uuid_cmp(name, &ksi->names[ksi->index[i]].name); i++) { if (n != ksi->names[ksi->index[i]].chunk) return HAL_ERROR_IMPOSSIBLE; if (blocknos != NULL && n < max_blocks) blocknos[n] = ksi->index[i]; n++; } if (n_blocks != NULL) *n_blocks = n; /* * Free the blocks and stuff them at the end of the free list. */ if (blocknos != NULL) { if (n > max_blocks) return HAL_ERROR_RESULT_TOO_LONG; const size_t len = (ksi->size - where - n) * sizeof(*ksi->index); memmove(&ksi->index[where], &ksi->index[where + n], len); ksi->used -= n; for (int i = 0; i < n; i++) { ksi->index[ksi->size - n + i] = blocknos[i]; memset(&ksi->names[blocknos[i]], 0, sizeof(ksi->names[blocknos[i]])); } where = -1; } if (hint != NULL) *hint = where; fsck(ksi); return HAL_OK; } /* * Replace a single block in the index. */ hal_error_t hal_ks_index_replace(hal_ks_index_t *ksi, const hal_uuid_t * const name, const unsigned chunk, unsigned *blockno, int *hint) { if (ksi == NULL || ksi->index == NULL || ksi->names == NULL || ksi->size == 0 || ksi->used > ksi->size || name == NULL) return HAL_ERROR_BAD_ARGUMENTS; if (ksi->used == ksi->size) return HAL_ERROR_NO_KEY_INDEX_SLOTS; int where; fsck(ksi); if (ksi->used == 0 || !ks_find(ksi, name, chunk, hint, &where)) return HAL_ERROR_KEY_NOT_FOUND; /* * Grab first block from free list, slide free list down, put old * block at end of free list and replace old block with new block. */ const size_t len = (ksi->size - ksi->used - 1) * sizeof(*ksi->index); const uint16_t b1 = ksi->index[where]; const uint16_t b2 = ksi->index[ksi->used]; memmove(&ksi->index[ksi->used], &ksi->index[ksi->used + 1], len); ksi->index[ksi->size - 1] = b1; ksi->index[where] = b2; ksi->names[b2].name = *name; ksi->names[b2].chunk = chunk; memset(&ksi->names[b1], 0, sizeof(ksi->names[b1])); if (blockno != NULL) *blockno = b2; if (hint != NULL) *hint = where; fsck(ksi); return HAL_OK; } /* * Local variables: * indent-tabs-mode: nil * End: */