Merge pull request 'dev' (#6) from dev into main

Reviewed-on: http://git.gandc.ru/gandc/myRPC/pulls/6

Makefile

@@ -1,98 +1,31 @@
-CC = gcc
+.PHONY: all clean deb repo systemd_install
-CFLAGS = -Wall -O2 -Ilibmysyslog
-LDFLAGS = -Lbuild -lmysyslog -lconfig
 
-BUILD_DIR = build
+all: clean
+	$(MAKE) -C libmysyslog all
+	$(MAKE) -C myRPC-client all
+	$(MAKE) -C myRPC-server all
 
-SRCS_CLIENT = myRPC-client.c
-SRCS_SERVER = myRPC-server.c
-
-OBJS_CLIENT = $(BUILD_DIR)/myRPC-client.o
-OBJS_SERVER = $(BUILD_DIR)/myRPC-server.o
-
-TARGET_CLIENT = $(BUILD_DIR)/myRPC-client
-TARGET_SERVER = $(BUILD_DIR)/myRPC-server
-
-LIB_SRC = libmysyslog/libmysyslog.c
-LIB_OBJ = $(BUILD_DIR)/libmysyslog.o
-LIB_A = $(BUILD_DIR)/libmysyslog.a
-
-# Переменные для deb-пакетов
-version = 1.0
-revision = 0
-architecture = all
-
-.PHONY: all clean deb repo
-
-all: $(BUILD_DIR) $(LIB_A) $(TARGET_CLIENT) $(TARGET_SERVER)
-
-$(BUILD_DIR):
-	mkdir -p $(BUILD_DIR)
-
-$(BUILD_DIR)/myRPC-client.o: myRPC-client.c | $(BUILD_DIR)
-	$(CC) $(CFLAGS) -c $< -o $@
-
-$(BUILD_DIR)/myRPC-server.o: myRPC-server.c | $(BUILD_DIR)
-	$(CC) $(CFLAGS) -c $< -o $@
-
-$(BUILD_DIR)/libmysyslog.o: $(LIB_SRC) | $(BUILD_DIR)
-	$(CC) $(CFLAGS) -fPIC -c $< -o $@
-
-$(LIB_A): $(BUILD_DIR)/libmysyslog.o
-	ar rcs $@ $^
-
-$(TARGET_CLIENT): $(OBJS_CLIENT)
-	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
-
-$(TARGET_SERVER): $(OBJS_SERVER)
-	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
-
-###############################################################################
-# Создание deb-пакетов
-###############################################################################
-
-# Цель deb собирает deb-пакеты для клиента и сервера, а затем очищает временные директории
-deb: deb_client deb_server
-	@rm -rf MyRPC_client_$(version)-$(revision)_$(architecture)
-	@rm -rf MyRPC_server_$(version)-$(revision)_$(architecture)
-
-# Создание deb-пакета для myRPC-client
-deb_client:
-	@mkdir -p MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN
-	@echo "Package: myrpc-client"                           > MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Version: $(version)"                             >> MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Architecture: $(architecture)"                   >> MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Maintainer: gandc <admin@gandc.ru>"  >> MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Description: Client for remote command execution via myRPC" >> MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@mkdir -p MyRPC_client_$(version)-$(revision)_$(architecture)/usr/local/bin
-	@cp $(TARGET_CLIENT) MyRPC_client_$(version)-$(revision)_$(architecture)/usr/local/bin
-	@dpkg-deb --root-owner-group --build MyRPC_client_$(version)-$(revision)_$(architecture)
-
-# Создание deb-пакета для myRPC-server
-deb_server:
-	@mkdir -p MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN
-	@echo "Package: myrpc-server"                           > MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Version: $(version)"                             >> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Architecture: $(architecture)"                   >> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Maintainer: gandc <admin@gandc.ru>"  >> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@echo "Description: Server for remote command execution via myRPC" >> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
-	@mkdir -p MyRPC_server_$(version)-$(revision)_$(architecture)/usr/local/bin
-	@cp $(TARGET_SERVER) MyRPC_server_$(version)-$(revision)_$(architecture)/usr/local/bin
-	@dpkg-deb --root-owner-group --build MyRPC_server_$(version)-$(revision)_$(architecture)
-
-###############################################################################
-# Создание локального репозитория APT
-###############################################################################
-repo:
-	@mkdir -p /usr/local/repos
-	@cp *.deb /usr/local/repos
-	@cd /usr/local/repos && dpkg-scanpackages . /dev/null | gzip -9c > Packages.gz
-	@echo "deb [trusted=yes] file:/usr/local/repos ./" | sudo tee /etc/apt/sources.list.d/myrpc.list
-	@sudo apt-get update
-
-###############################################################################
-# Очистка временных файлов
-###############################################################################
 clean:
-	rm -rf $(BUILD_DIR)
+	$(MAKE) -C libmysyslog clean
+	$(MAKE) -C myRPC-client clean
+	$(MAKE) -C myRPC-server clean
 	rm -f *.deb
+
+deb: all
+	$(MAKE) -C libmysyslog deb
+	$(MAKE) -C myRPC-client deb
+	$(MAKE) -C myRPC-server deb
+	mv libmysyslog/*.deb .
+	mv myRPC-client/*.deb .
+	mv myRPC-server/*.deb .
+
+repo: deb
+	mkdir -p /usr/local/repos
+	cp *.deb /usr/local/repos
+	cd /usr/local/repos && dpkg-scanpackages . /dev/null | gzip -9c > Packages.gz
+	echo "deb [trusted=yes] file:/usr/local/repos ./" | sudo tee /etc/apt/sources.list.d/myrpc.list
+	sudo apt-get update
+
+systemd_install:
+	sudo cp systemd/myrpc-server.service /etc/systemd/system/
+	sudo systemctl daemon-reload

README.md

@@ -7,12 +7,24 @@
 ## Структура проекта
 
 ```
-myrpc/
+myRPC/
 ├── libmysyslog/
+│   ├── Makefile
+│   ├── README.md
 │   ├── libmysyslog.c
 │   └── libmysyslog.h
-├── myRPC-client.c
+├── systemd/
-├── myRPC-server.c
+│   └── myrpc-server.service
+├── myRPC-client/
+│   ├── Makefile
+│   ├── README.md
+│   └── src/
+│   	└── myRPC-client.c
+├── myRPC-server
+│   ├── Makefile
+│   ├── README.md
+│   └── src/
+│   	└── myRPC-server.c
 └── Makefile
 ```
 
@@ -30,10 +42,18 @@ myrpc/
 make all
 ```
 
-Сборка производится в директории `build`. Там же будут размещены исполняемые файлы:
+Сборка производится в директории соответствующих подпроектам дирректориях. Там же будут размещены исполняемые файлы:
 
-- `build/myRPC-client`
+- `myRPC-client/myRPC-client`
-- `build/myRPC-server`
+- `myRPC-server/myRPC-server`
+
+### Подлючение библиотеки проекта
+
+1. При работе на локальном машине, требуется подключить библиотеку `libmysyslog` для работоспособности проекта.
+2. Выполните следующую команду:
+```sh
+export LD_LIBRARY_PATH=/home/user/myRPC/libmysyslog:$LD_LIBRARY_PATH
+```
 
 ## Использование
 
@@ -41,34 +61,38 @@ make all
 
 Создайте конфигурационный файл `/etc/myRPC/myRPC.conf` со следующим содержимым:
 
-```
+   ```conf
-port = 1234;
+   # Порт, на котором будет слушать сервер
-socket_type = "stream";
+   port = 1234
+   # Тип сокета : stream(TCP) или dgram(UDP)
+   socket_type = stream
    ```
 
 Создайте файл со списком разрешенных пользователей `/etc/myRPC/users.conf`:
 
-```
+   ```conf
+   # Список разрешённых пользователей
    username1
    username2
+   username3
    ```
 
 Запустите сервер:
 
 ```bash
-sudo ./build/myRPC-server
+sudo myRPC-server
 ```
 
 ### Использование клиента
 
 ```bash
-./build/myRPC-client -h <адрес_сервера> -p <порт> -s -c "команда bash"
+myRPC-client -h <адрес_сервера> -p <порт> -s -c "команда bash"
 ```
 
 Пример:
 
 ```bash
-./build/myRPC-client -h 127.0.0.1 -p 1234 -s -c "ls -la"
+myRPC-client -h 127.0.0.1 -p 1234 -s -c "ls -la"
 ```
 
 ## Создание deb-пакетов
@@ -93,6 +117,12 @@ make repo
 sudo apt-get install myrpc-client myrpc-server
 ```
 
+## systemd unit
+```bash
+make systemd_install
+```
+
+
 ## Очистка
 
 Очистка временных файлов и папок:

libmysyslog/Makefile

@@ -0,0 +1,38 @@
+CC = gcc
+CFLAGS = -Wall -O2 -fPIC
+
+SRC = libmysyslog.c
+OBJ = libmysyslog.o
+STATIC = libmysyslog.a
+SHARED = libmysyslog.so
+
+version     = 1.0
+revision    = 0
+architecture = all
+
+.PHONY: all clean deb
+
+all: $(STATIC) $(SHARED)
+
+$(OBJ): $(SRC)
+	$(CC) $(CFLAGS) -c $< -o $@
+
+$(STATIC): $(OBJ)
+	ar rcs $@ $^
+
+$(SHARED): $(OBJ)
+	$(CC) -shared -o $@ $^
+
+deb:
+	mkdir -p MySyslog_library_$(version)-$(revision)_$(architecture)/DEBIAN
+	printf "Package: libmysyslog\nVersion: $(version)\nArchitecture: $(architecture)\nMaintainer: gandc <admin@gandc.ru>\nDescription: Core library for mysyslog logging\n" \
+		> MySyslog_library_$(version)-$(revision)_$(architecture)/DEBIAN/control
+	mkdir -p MySyslog_library_$(version)-$(revision)_$(architecture)/usr/local/lib
+	mkdir -p MySyslog_library_$(version)-$(revision)_$(architecture)/usr/local/include
+	cp $(STATIC) MySyslog_library_$(version)-$(revision)_$(architecture)/usr/local/lib
+	cp libmysyslog.h MySyslog_library_$(version)-$(revision)_$(architecture)/usr/local/include
+	dpkg-deb --root-owner-group --build MySyslog_library_$(version)-$(revision)_$(architecture)
+
+clean:
+	rm -f $(OBJ) $(STATIC) $(SHARED)
+	rm -rf MySyslog_library_$(version)-$(revision)_$(architecture)

libmysyslog/README.md

@@ -0,0 +1,25 @@
+# Библиотека libmysyslog на языке Си
+Разработать расширяемую библиотеку libmysyslog на языке Си, которая сможет выводить данные в журнал в разных форматах. В рамках библиотеки необходимо реализовать функцию, через которую другие программы смогут выводить данные в журнал:
+```c
+int mysyslog(const char* msg, int level, int driver, int format, const char* path);
+```
+Поддерживаются следующие уровни журналирования: DEBUG, INFO, WARN, ERROR, CRITICAL.
+
+Для библиотеки libmysyslog реализованы в виде подключаемого плагина 2 драйвера (libmysyslog-text, libmysyslog-json): вывод в журнал в виде строки с разделителем и вывод в журнал в виде json строки.
+
+Структура журнала в текстовом формате:
+```
+timestamp log_level process message
+```
+Пример журнала в текстовом формате:
+```
+1439482969 ERROR example-app this is an error
+```
+Структура журнала в формате JSON:
+```json
+{"timestamp": ..., "log_level": ..., "process": ..., "message": ...}
+```
+Пример журнала в формате JSON:
+```json
+{"timestamp":1439482969,"log_level":"ERROR","process":"example-app","message":"this is an error"}
+```

myRPC-client/Makefile

@@ -0,0 +1,42 @@
+CC := gcc  
+#LIBDIR := ../libmysyslog  
+CFLAGS := -Wall -O2
+# -Wall -O2 -I$(LIBDIR)  
+LDFLAGS := 
+#-L$(LIBDIR) -lmysyslog  
+
+SRC := src/myRPC-client.c  
+OBJ := myRPC-client.o  
+BIN := myRPC-client  
+
+version     := 1.0
+revision    := 0
+architecture := all
+
+.PHONY: all clean deb  
+
+all: $(BIN)
+#$(LIBDIR)/libmysyslog.so $(BIN)  
+
+#$(LIBDIR)/libmysyslog.so:  
+#	$(MAKE) -C $(LIBDIR)  
+
+$(OBJ): $(SRC)  
+	$(CC) $(CFLAGS) -c $< -o $@  
+
+$(BIN): $(OBJ)  
+	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)  
+
+deb: deb_client all
+	@rm -rf MyRPC_client_$(version)-$(revision)_$(architecture)  
+
+deb_client:
+	mkdir -p MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN  
+	printf "Package: myrpc-client\nVersion: $(version)\nArchitecture: $(architecture)\nDepends: libmysyslog\nMaintainer: gandc <admin@gandc.ru>\nDescription: Client for remote command execution via myRPC\n" \
+		> MyRPC_client_$(version)-$(revision)_$(architecture)/DEBIAN/control
+	mkdir -p MyRPC_client_$(version)-$(revision)_$(architecture)/usr/local/bin  
+	cp $(BIN) MyRPC_client_$(version)-$(revision)_$(architecture)/usr/local/bin  
+	dpkg-deb --root-owner-group --build MyRPC_client_$(version)-$(revision)_$(architecture)  
+
+clean:  
+	rm -f $(OBJ) $(BIN)  

myRPC-client/README.md

@@ -0,0 +1,25 @@
+Консольная утилита для отправки команд на удалённый myRPC-сервер.
+
+## Сборка
+
+```bash
+cd myRPC-client
+make all
+```
+
+В результате появится исполняемый файл `myRPC-client`.
+
+## Использование
+
+```bash
+./myRPC-client -s|--stream | -d|--dgram \
+               -h <IP_сервера> \
+               -p <порт> \
+               -c|--command "bash команда"
+```
+
+Примеры:
+```bash
+./myRPC-client -s -h 192.168.0.10 -p 1234 -c "ls -la /tmp"
+./myRPC-client --dgram --host 10.0.0.5 --port 4321 --command "df -h"
+```

myRPC-server/Makefile

@@ -0,0 +1,73 @@
+CC := gcc
+PKG_CONFIG := pkg-config
+
+CONFIG_CFLAGS  := $(shell $(PKG_CONFIG) --cflags libconfig)
+CONFIG_LDFLAGS := $(shell $(PKG_CONFIG) --libs libconfig)
+
+LIBDIR := ../libmysyslog
+
+CFLAGS := -Wall -O2 -I$(LIBDIR) $(CONFIG_CFLAGS)
+LDFLAGS := -L$(LIBDIR) -lmysyslog $(CONFIG_LDFLAGS)
+
+SRC := src/myRPC-server.c
+OBJ := myRPC-server.o
+BIN := myRPC-server
+
+version     := 1.0
+revision    := 0
+architecture := all
+
+.PHONY: all clean deb systemd_install
+
+all: $(BIN)
+# $(LIBDIR)/libmysyslog.a $(BIN)
+
+#$(LIBDIR)/libmysyslog.a:
+#	$(MAKE) -C $(LIBDIR)
+
+# Compile server
+$(OBJ): $(SRC)
+	$(CC) $(CFLAGS) -c $< -o $@
+
+# Link server
+$(BIN): $(OBJ)
+	$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
+
+###############################################################################
+# deb
+###############################################################################
+
+deb: deb_server all
+	@rm -rf MyRPC_server_$(version)-$(revision)_$(architecture)
+
+deb_server:
+	mkdir -p MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN
+	printf "Package: myrpc-server\nVersion: $(version)\nArchitecture: $(architecture)\nDepends: libmysyslog\nMaintainer: gandc <admin@gandc.ru>\nDescription: Server for remote command execution via myRPC\n" \
+		> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/control
+
+	mkdir -p MyRPC_server_$(version)-$(revision)_$(architecture)/usr/local/bin
+	cp $(BIN) MyRPC_server_$(version)-$(revision)_$(architecture)/usr/local/bin
+
+	mkdir -p MyRPC_server_$(version)-$(revision)_$(architecture)/lib/systemd/system
+	cp ../systemd/myrpc-server.service MyRPC_server_$(version)-$(revision)_$(architecture)/lib/systemd/system
+
+	printf "#!/bin/sh\nsystemctl daemon-reload\n" \
+		> MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/postinst
+	chmod 755 MyRPC_server_$(version)-$(revision)_$(architecture)/DEBIAN/postinst
+
+	dpkg-deb --root-owner-group --build MyRPC_server_$(version)-$(revision)_$(architecture)
+
+###############################################################################
+# Copy unit and reload systemd
+###############################################################################
+
+systemd_install:
+	sudo cp ../systemd/myrpc-server.service /etc/systemd/system/
+	sudo systemctl daemon-reload
+
+###############################################################################
+# Cleanup
+###############################################################################
+
+clean:
+	rm -f $(OBJ) $(BIN)

myRPC-server/README.md

@@ -0,0 +1,57 @@
+Служба-демон для удалённого выполнения команд по протоколу myRPC.
+
+## Зависимости
+
+- GCC (gcc)
+- libconfig (`libconfig-dev`)
+- libmysyslog (собирается в подпроекте `libmysyslog`)
+- pkg-config
+
+Установите зависимости:
+```bash
+sudo apt-get update
+sudo apt-get install -y gcc make libconfig-dev pkg-config
+```
+
+## Сборка
+
+```bash
+cd myRPC-server
+make all
+```
+
+- Соберётся бинарник `myRPC-server` в текущей папке.
+- Он автоматически требует, чтобы в соседней папке `../libmysyslog` уже была собрана библиотека `libmysyslog.a` или `.so`. Если не собрана, запустите там `make all`.
+
+## Настройка
+
+1. Создайте каталог `/etc/myRPC`:
+   ```bash
+   sudo mkdir -p /etc/myRPC
+   ```
+2. Файл `/etc/myRPC/myRPC.conf`:
+   ```conf
+   port = 1234;
+   socket_type = "stream";   # stream или dgram
+   ```
+3. Файл `/etc/myRPC/users.conf` — список разрешённых пользователей, по одному на строку:
+   ```
+   alice
+   bob
+   ```
+
+## Запуск
+```bash
+sudo ./myRPC-server
+```
+
+## Пакет
+
+Создать DEB-пакет:
+```bash
+make deb
+```
+Получится `MyRPC_server_1.0-0_all.deb`. Устанавливается командой:
+```bash
+sudo dpkg -i MyRPC_server_1.0-0_all.deb
+```

systemd/myrpc-server.service

@@ -0,0 +1,13 @@
+[Unit]
+Description=myRPC Server Service
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=/usr/local/bin/myRPC-server
+Restart=always
+User=root
+Environment=PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+[Install]
+WantedBy=multi-user.target