I say: pip install signal-cli-rest-api, and got an error:

Collecting signal-cli-rest-api
  Could not find a version that satisfies the requirement signal-cli-rest-api (from versions: )
No matching distribution found for signal-cli-rest-api

OS is Debian Buster, 64-bit.

When running registration like this (with a random number)

curl -X 'POST' \
  'http://localhost:8000/register/%2B49080500' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "voice_verification": true
}'

I am getting the following error:

{
  "detail": "Starting signal-cli process failed: Captcha required for verification, use --captcha CAPTCHA\nTo get the token, go to https://signalcaptchas.org/registration/generate.html\nCheck the developer tools (F12) console for a failed redirect to signalcaptcha://\nEverything after signalcaptcha:// is the captcha token.\n"
}

Before I start poking around, maybe I am missing an obvious step? Is the captcha functionality already built into this wrapper?

Btw, If this is an easy one, I would be happy to add documentation.

A newline character causes the QR code for device linking to be faulty. I am not providing a PR as I am unsure whether this can be safely escaped in run_signal_cli_command without affecting other functions, or if it should be done in link_device.

This PR escapes all strings that are passed to the signal-cli shell command in order to prevent shell injections. It uses a function from the shlex libary that provides

... a shell-escaped version of the string s. The returned value is a string that can safely be used as one token in a shell command line, for cases where you cannot use a list. [https://docs.python.org/3/library/shlex.html#shlex.quote]

I could not yet test all the commands for possible issues with the escaping.

I'm using the workaround fix that is mentioned here

and have updated the schema/register.py and endpoint/register.py files as per the changes a couple days ago (Fixed Captcha).

I'm getting the following when trying to register a number: INFO: 192.168.0.117:56688 - "POST /register/xxx HTTP/1.1" 500 Internal Server Error (I replaced my phone # +1231231234 with xxx) and {"detail":"Starting signal-cli process failed: OpenJDK Server VM warning: You have loaded library /tmp/resource1973025829374288195.so which might have disabled stack guard. The VM will try to fix the stack guard now.\nIt's highly recommended that you fix the library with 'execstack -c <libfile>', or link it with '-z noexecstack'.\nWARN App - WARNING: Support for new group V2 is disabled, because the required native library dependency is missing: libzkgroup\nMissing required native library dependency: libsignal-client\n"}

how about these small housekeeping commits? @SebastianLuebke, hope this goes into the right direction for you. feedback & change requests are welcome.

I got below error code 500 "Internal Server Error" Is there any guidance?

INFO: 127.0.0.1:53539 - "POST /messages/00966546462471 HTTP/1.1" 500 Internal Server Error ERROR: Exception in ASGI application Traceback (most recent call last): File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\uvicorn-0.11.8-py3.7.egg\uvicorn\protocols\http\h11_impl.py", line 388, in run_asgi result = await app(self.scope, self.receive, self.send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\uvicorn-0.11.8-py3.7.egg\uvicorn\middleware\proxy_headers.py", line 45, in __call__ return await self.app(scope, receive, send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\fastapi-0.58.1-py3.7.egg\fastapi\applications.py", line 171, in __call__ await super().__call__(scope, receive, send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\applications.py", line 102, in __call__ await self.middleware_stack(scope, receive, send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\middleware\errors.py", line 181, in __call__ raise exc from None File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\middleware\errors.py", line 159, in __call__ await self.app(scope, receive, _send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\exceptions.py", line 82, in __call__ raise exc from None File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\exceptions.py", line 71, in __call__ await self.app(scope, receive, sender) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\routing.py", line 550, in __call__ await route.handle(scope, receive, send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\routing.py", line 227, in handle await self.app(scope, receive, send) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\starlette-0.13.4-py3.7.egg\starlette\routing.py", line 41, in app response = await func(request) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\fastapi-0.58.1-py3.7.egg\fastapi\routing.py", line 197, in app dependant=dependant, values=values, is_coroutine=is_coroutine File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\fastapi-0.58.1-py3.7.egg\fastapi\routing.py", line 147, in run_endpoint_function return await dependant.call(**values) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\signal_cli_rest_api-0.1.97-py3.7.egg\signal_cli_rest_api\app\api\api_v1\endpoints\messages.py", line 50, in send_message response = await run_signal_cli_command(cmd) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\site-packages\signal_cli_rest_api-0.1.97-py3.7.egg\signal_cli_rest_api\app\utils.py", line 73, in run_signal_cli_command process = await asyncio.subprocess.create_subprocess_shell(full_cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\asyncio\subprocess.py", line 202, in create_subprocess_shell stderr=stderr, **kwds) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\asyncio\base_events.py", line 1510, in subprocess_shell protocol, cmd, True, stdin, stdout, stderr, bufsize, **kwargs) File "C:\Users\Admin\AppData\Local\Programs\Python\Python37\lib\asyncio\base_events.py", line 462, in _make_subprocess_transport raise NotImplementedError NotImplementedError

The send_message method of the messages endpoint does not append the groupID for group messages, resulting in an error when an API call with group: true is made. In fact, this field is also missing in the MessageOutgoing schema.

This is the relevant section from the signal-cli man-page:

-g GROUP, --group GROUP

Specify the recipient group ID in base64 encoding.

On signal-cli 0.8.1, incomming message doesn't containt any isReceipt key in the JSON response, so when validating the schemas it resulting in following error:

 raise ValidationError(errors, field.type_)
pydantic.error_wrappers.ValidationError: 1 validation error for MessageIncoming
response -> 0 -> envelope -> isReceipt
  field required (type=value_error.missing)

Here is the complete example of "new" JSON response in incomming message:

{
	"envelope": {
		"source": "+6217081945001",
		"sourceDevice": 1,
		"timestamp": 1619484875616,
		"dataMessage": {
			"timestamp": 1619484875616,
			"message": "Pray for Nanggala 402",
			"expiresInSeconds": 0,
			"viewOnce": false,
			"mentions": [],
			"attachments": [],
			"contacts": []
		}
	}
}

Applied fix, we remove the isReceipt key from envelope schemas validator.

When received message, parameter error occured resulting in 500 Server Error.

  "detail": "Starting signal-cli process failed: WARN ReceiveCommand - \"--json\" option has been deprecated, please use the global \"--output=json\" instead.\n"
}

Patch apllied to messages.py, changing the --json parameter into new --output=json and ajusting the parameter position.

In version 0.7.0 signal-cli introduced support for V2 groups. This requires some native libraries that are compiled against glibc. This PR (again) changes the base image of the Dockerfile to make this work. In addition, the container now runs as unprivileged user.

Changes in this PR:

• update to latest signal-cli release
• run as unprivileged user
• install poetry via pip

Breaking changes:

• update mount path for persistent signal-cli volume to /srv/signal/.local/share/signal-cli

Bumps fastapi from 0.58.1 to 0.65.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Hello, everytime I try to get /message, I have an internal 500 error:

500 Internal Server Error ERROR: Exception in ASGI application Traceback (most recent call last): File "/usr/local/lib/python3.8/dist-packages/uvicorn/protocols/http/httptools_impl.py", line 390, in run_asgi result = await app(self.scope, self.receive, self.send) File "/usr/local/lib/python3.8/dist-packages/uvicorn/middleware/proxy_headers.py", line 45, in call return await self.app(scope, receive, send) File "/usr/local/lib/python3.8/dist-packages/fastapi/applications.py", line 171, in call await super().call(scope, receive, send) File "/usr/local/lib/python3.8/dist-packages/starlette/applications.py", line 102, in call await self.middleware_stack(scope, receive, send) File "/usr/local/lib/python3.8/dist-packages/starlette/middleware/errors.py", line 181, in call raise exc from None File "/usr/local/lib/python3.8/dist-packages/starlette/middleware/errors.py", line 159, in call await self.app(scope, receive, _send) File "/usr/local/lib/python3.8/dist-packages/starlette/exceptions.py", line 82, in call raise exc from None File "/usr/local/lib/python3.8/dist-packages/starlette/exceptions.py", line 71, in call await self.app(scope, receive, sender) File "/usr/local/lib/python3.8/dist-packages/starlette/routing.py", line 550, in call await route.handle(scope, receive, send) File "/usr/local/lib/python3.8/dist-packages/starlette/routing.py", line 227, in handle await self.app(scope, receive, send) File "/usr/local/lib/python3.8/dist-packages/starlette/routing.py", line 41, in app response = await func(request) File "/usr/local/lib/python3.8/dist-packages/fastapi/routing.py", line 196, in app raw_response = await run_endpoint_function( File "/usr/local/lib/python3.8/dist-packages/fastapi/routing.py", line 149, in run_endpoint_function return await run_in_threadpool(dependant.call, **values) File "/usr/local/lib/python3.8/dist-packages/starlette/concurrency.py", line 34, in run_in_threadpool return await loop.run_in_executor(None, func, *args) File "/usr/lib/python3.8/concurrent/futures/thread.py", line 57, in run result = self.fn(*self.args, **self.kwargs) File "/usr/local/lib/python3.8/dist-packages/signal_cli_rest_api/app/api/api_v1/endpoints/messages.py", line 24, in get_messages return [json.loads(m) for m in response.split("\n") if m != ""] AttributeError: 'coroutine' object has no attribute 'split' /usr/local/lib/python3.8/dist-packages/uvicorn/main.py:390: RuntimeWarning: coroutine 'run_signal_cli_command' was never awaited loop.run_until_complete(self.serve(sockets=sockets)) RuntimeWarning: Enable tracemalloc to get the object allocation traceback