Initial commit

Author: tsl0922

.gitignore

@@ -0,0 +1,52 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+
+# Cmake files
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Makefile
+cmake_install.cmake
+install_manifest.txt
+CTestTestfile.cmake
+build
+
+# Clion files
+.idea/
+
+# Project files
+html.h

CMakeLists.txt

@@ -0,0 +1,43 @@
+cmake_minimum_required(VERSION 2.8)
+project(ttyd)
+
+set(SOURCE_FILES server.c http.c protocol.c)
+
+find_package(OpenSSL REQUIRED)
+find_package(Libwebsockets QUIET)
+
+# libwebsockets 1.x doesn't support cmake
+if (NOT Libwebsockets_DIR)
+    pkg_check_modules(Libwebsockets REQUIRED libwebsockets)
+    find_path(LIBWEBSOCKETS_INCLUDE_DIR libwebsockets.h
+            HINTS ${LIBWEBSOCKETS_INCLUDEDIR} ${LIBWEBSOCKETS_INCLUDE_DIRS})
+    find_library(LIBWEBSOCKETS_LIBRARIES NAMES websockets libwebsockets
+            HINTS ${LIBWEBSOCKETS_LIBDIR} ${LIBWEBSOCKETS_LIBRARY_DIRS})
+    include(FindPackageHandleStandardArgs)
+    find_package_handle_standard_args(LIBWEBSOCKETS DEFAULT_MSG LIBWEBSOCKETS_LIBRARIES LIBWEBSOCKETS_INCLUDE_DIR)
+    mark_as_advanced(LIBWEBSOCKETS_INCLUDE_DIR LIBWEBSOCKETS_LIBRARIES)
+endif()
+
+find_package(PkgConfig)
+pkg_check_modules(PC_JSON-C REQUIRED json-c)
+find_path(JSON-C_INCLUDE_DIR json.h
+        HINTS ${PC_JSON-C_INCLUDEDIR} ${PC_JSON-C_INCLUDE_DIRS} PATH_SUFFIXES json-c json)
+find_library(JSON-C_LIBRARY NAMES json-c libjson-c
+        HINTS ${PC_JSON-C_LIBDIR} ${PC_JSON-C_LIBRARY_DIRS})
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(JSON-C DEFAULT_MSG JSON-C_LIBRARY JSON-C_INCLUDE_DIR)
+mark_as_advanced(JSON-C_INCLUDE_DIR JSON-C_LIBRARY)
+
+find_program(CMAKE_XXD NAMES xxd)
+add_custom_command(OUTPUT html.h
+        COMMAND ${CMAKE_XXD} -i index.html html.h
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+        COMMENT "Generating html.h from index.html")
+list(APPEND SOURCE_FILES html.h)
+
+set(INCLUDE_DIRS ${OPENSSL_INCLUDE_DIR} ${LIBWEBSOCKETS_INCLUDE_DIR} ${JSON-C_INCLUDE_DIR})
+set(LINK_LIBS util pthread ${OPENSSL_LIBRARIES} ${LIBWEBSOCKETS_LIBRARIES} ${JSON-C_LIBRARY})
+
+add_executable(${PROJECT_NAME} ${SOURCE_FILES})
+target_include_directories(${PROJECT_NAME} PUBLIC ${INCLUDE_DIRS})
+target_link_libraries(${PROJECT_NAME} ${LINK_LIBS})

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Shuanglei Tao <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+# ttyd - terminal emulator for the web
+
+ttyd is a simple command line tool for sharing terminal over the web, inspired by [GoTTY](https://github.com/yudai/gotty).
+
+![screenshot](screenshot.gif)
+
+> **WARNING:** ttyd is still under heavily development, so features may be incomplete or expected to have bugs.
+
+# Requirements
+
+- [CMake](https://cmake.org)
+- [OpenSSL](https://www.openssl.org)
+- [JSON-C](https://github.com/json-c/json-c)
+- [Libwebsockets](https://libwebsockets.org)
+
+# Installation
+
+### For Mac OS X users
+
+```bash
+brew install cmake openssl json-c libwebsockets
+git clone https://github.com/tsl0922/ttyd.git
+cd ttyd && mkdir build && cd build
+cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl ..
+make
+```
+
+### For Linux users
+
+Ubuntu as example:
+
+```bash
+sudo apt-get install cmake libwebsockets-dev libjson-c-dev libssl-dev
+git clone https://github.com/tsl0922/ttyd.git
+cd ttyd && mkdir build && cd build
+cmake ..
+make
+```
+
+The `ttyd` executable file will be in the `build` directory.
+
+# Usage
+
+```
+Usage: ttyd command [options]
+```
+
+ttyd will start a web server at port `7681`. When you open <http://localhost:7681>, the `command` will be started with `options` as arguments and now you can see the running command on the web! :tada: 
+
+# Credits
+
+- [GoTTY](https://github.com/yudai/gotty): ttyd is a port of GoTTY to `C` language.
+- [hterm](https://chromium.googlesource.com/apps/libapps/+/HEAD/hterm): ttyd uses hterm to run a terminal emulator on the web.

http.c

@@ -0,0 +1,75 @@
+#include "server.h"
+#include "html.h"
+
+int
+callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len) {
+    unsigned char buffer[4096 + LWS_PRE];
+    unsigned char *p;
+    unsigned char *end;
+    char buf[256];
+    int n;
+
+    switch (reason) {
+        case LWS_CALLBACK_HTTP:
+            lwsl_notice("lws_http_serve: %s\n", in);
+
+            {
+                char name[100], rip[50];
+                lws_get_peer_addresses(wsi, lws_get_socket_fd(wsi), name,
+                                       sizeof(name), rip, sizeof(rip));
+                sprintf(buf, "%s (%s)", name, rip);
+                lwsl_notice("HTTP connect from %s\n", buf);
+            }
+
+            if (len < 1) {
+                lws_return_http_status(wsi, HTTP_STATUS_BAD_REQUEST, NULL);
+                goto try_to_reuse;
+            }
+
+            if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
+                return 0;
+
+            if (strcmp((const char *) in, "/")) {
+                lws_return_http_status(wsi, HTTP_STATUS_NOT_FOUND, NULL);
+                goto try_to_reuse;
+            }
+
+            p = buffer + LWS_PRE;
+            end = p + sizeof(buffer) - LWS_PRE;
+
+            if (lws_add_http_header_status(wsi, 200, &p, end))
+                return 1;
+            if (lws_add_http_header_by_token(wsi,
+                                             WSI_TOKEN_HTTP_CONTENT_TYPE,
+                                             (unsigned char *) "text/html",
+                                             9, &p, end))
+                return 1;
+            if (lws_add_http_header_content_length(wsi, index_html_len, &p, end))
+                return 1;
+            if (lws_finalize_http_header(wsi, &p, end))
+                return 1;
+            n = lws_write(wsi, buffer + LWS_PRE, p - (buffer + LWS_PRE), LWS_WRITE_HTTP_HEADERS);
+            if (n < 0) {
+                return 1;
+            }
+
+            n = lws_write_http(wsi, index_html, index_html_len);
+            if (n < 0)
+                return 1;
+            goto try_to_reuse;
+        case LWS_CALLBACK_HTTP_WRITEABLE:
+            lwsl_info("LWS_CALLBACK_HTTP_WRITEABLE\n");
+            break;
+        default:
+            break;
+    }
+
+    return 0;
+
+    /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
+    try_to_reuse:
+    if (lws_http_transaction_completed(wsi))
+        return -1;
+
+    return 0;
+}