Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sergei-mironov/asterisk-dongle-setup

Playground project aimed at setting up Asterisk server and the GSM stack on Nix.
https://github.com/sergei-mironov/asterisk-dongle-setup

asterisk chan-dongle nix sip telegram-api telethon

Last synced: 3 months ago
JSON representation

Playground project aimed at setting up Asterisk server and the GSM stack on Nix.

Awesome Lists containing this project

README 

        
Asterisk-dongle-setup

=====================



This project aims at wiring together many pieces of Linux software required to

do the following:



* [x] Receive SMS messages and forward them to a Telegram chat.

* [x] Receive GSM voice calls and forward them to ~~Telegram voice calls~~ (Telegram voice calls are broken due to https://github.com/Infactum/tg2sip/issues/63)

or to a SIP client.

* [x] Forward outgoing voice calls ~~from Telegram~~ from SIP client back to GSM

* [x] Handle incoming voice calls with a [Lenny prank bot](https://ottawacitizen.com/news/local-news/pitch-perfect-prank-lenny-answers-the-politicians-call).

* [ ] Voice room with a chat bot.



Specifically, the setup includes [Asterisk server](http://asterisk.org/) with

the [GSM-modem dongle](https://github.com/wdoekes/asterisk-chan-dongle) and

[tg2sip](https://github.com/Infactum/tg2sip) bridge and many other components

glued together with Shell and Python scripts. The high degree of build

automation is achieved thanks to the [Nix](https://nixos.org) package manager.



![Scheme](./scheme.png)



Contents

--------



1. [Contents](#contents)

2. [Setup](#setup)

   * [Walkthrough](#walkthrough)

   * [Doing USB Modeswitch manually](#doing-usb-modeswitch-manually)

   * [Nix-shell](#nix-shell)

3. [Usage](#usage)

4. [Hardware notes](#hardware-notes)

5. [Known issues](#known-issues)

6. [Thirdparty issues](#thirdparty-issues)

7. [Administration hints](#administration-hints)

   * [Ulaw audio operations:](#ulaw-audio-operations:)

   * [Cutting last x seconds from an audio file](#cutting-last-x-seconds-from-an-audio-file)

   * [Clearing dongle SMS messages](#clearing-dongle-sms-messages)

   * [Useful Asterisk commands](#useful-asterisk-commands)

8. [References](#references)

   * [GSM modems](#gsm-modems)

   * [Asterisk](#asterisk)

   * [Telegram](#telegram)

   * [Fun](#fun)



Setup

-----



### Walkthrough



0. Install [Nix package manager](https://nixos.org/guides/install-nix.html) and

   update Nixpkgs repositories. This whole project is designed as a collection

   of nix-build expressions.

   * Note that Nix could co-exist with your native package manager.

   * We use

     [21.05 Nixpkgs branch commit](https://github.com/NixOS/nixpkgs/tree/d5aadbefd650cb0a05ba9c788a26327afce2396c/)

     as a base, but older 20.03 commits should also work.

1. Go and get a GSM modem.



   ![Modem E173](Modem_E173.jpg)



   You need to find a

   supported GSM modem and plug it into the USB port of your computer. We tested

   `Huawei-E173` only, but in theory any model supported by

   [chan_dongle](https://github.com/wdoekes/asterisk-chan-dongle)

   should work.

   - A somewhat outdated document about supported hardware is available

     [here](https://github.com/bg111/asterisk-chan-dongle/wiki/Requirements-and-Limitations).

     We typically do care about Voice and SMS functions and don't care about USSD.

   - `./run.sh` will check for the presence of `/dev/ttyUSB0`. If

     it is not present, the script would attempt to run the `usb_modeswitch`

     procedure.

   - **Currently we automate switching only for Huawei E173 modem**.

     For other models, try to follow the section about [manual mode-switching](#Doing-USB-Modeswitch-manually).

2. `git clone --recursive  ; cd ...`

3. Create `./secrets.nix` file by copying and editing `./secrets_template.nix`.

   - You need a mobile phone which is bound to some Telegram account.

   - Go to https://my.telegram.org/auth and register an API Client instance.

     You will be provided with `api_id` and `api_hash` values.

   - The bot token field is not currently used.

   - The Chat id field is a (typically negative) identifier of a chat to send SMS messages

     to. `./run.sh` will print available chat identifiers at

     some point during the startup.

4. **Please be informed that the main script `./run.sh` is VERY INSECURE.

   It configures Asterisk to use binary codec and then runs it as root.**

5. If you are OK with the above notice, run `./run.sh`.

   - The script asks Nix to (re-)build everything that is required.

   - At first run script will initialize Telegram session for python relay

     script.

     + As a part of initialization, Telegram server will send a digital

       code to your Telegram account.

     + You are to type this code back into the script.

   - At first run the script will also initialize another Telegram session, this

     time for `tg2sip` (TODO: find out how to reuse the first session).

     + It will ask you a phone number with Telegram account.

     + Telegram will send a code to your account. You have to read it and type

       it back into the script.

   - At every run, the script runs a number of background services including the

     Asteris ARI client, SMS spool script, tg2sip application etc.

   - Finally, the Asterisk is run in foreground. You should see its `*CLI>`

     console prompt and be able type commands.

6. ???

7. Check the [Usage](#usage) section.



### Doing USB Modeswitch manually



`run.sh` attempts to run usb_modeswitch procedure automatically for devices

known to author. In case the procedure fails, one could attempt the manual way:



1. `nix-build -A usb_modeswitch`.

2. `lsusb` to find out your modem's vendor:product numbers

3. `sudo ./result/usr/sbin/usb_modeswitch -v  -p  -X`

4. `/dec/ttyUSB[01]` devices should appear. You should be able

   to `minicom -D /dev/ttyUSB0` and type some AT command, say `ATI`.

5. Update `run.sh` script by adding new line like below to the

   corresponding place

   ```

   try_to_deal_with "" "" && wait_for_chardev "/dev/ttyUSB0"

   ```

6. Send us a PR with it.



### Nix-shell



Author uses VIM as the main development IDE. The start procedure is as follows:



```

$ nix-shell

(nix-shell) $ vim .   # Edit sources enjoying code navigaiton

(nix-shell) $ ipython # Testing telethon bot, etc

```



Usage

-----



* To send SMS from the GSM modem, use the Asterisk CLI: `dongle sms dongle0

  89097777777 HiHi`.

* Send SMS or make a call to your GSMmodem SIM card's number. Asterisk will

  redirect the call to your `telegram_master_nicname` Telegram account.

  - For voice calls, If you pick up the phone from your Telegram account (the

    green button), the GSM-to-Telegram connection will be established.

  - If you cancel the Telegram call by pressing the red button instead, the

    caller will be handled by the brave

    [Lenny](https://crosstalksolutions.com/howto-pwn-telemarketers-with-lenny/)

    chatbot.

  - In either case, Asterisk will record the call and send the recording to the

    Telegram `telegram_chat_id` (could be a group) with `wav` attachments.

* From a thirdparty telegram account call to the account associated with

  `secrets.telegram_phone`, then go to the private chat and send a message with

  a phone number to call to. Asterisk will initiate an outgoing call

  from your Telegram account to the GSM network.

* Here is how to use a SIP softphone application, e.g.

  [linphone](https://www.linphone.org/)

  - Install the softphone application.

  - Setup a local SIP account: `` where

    `192.168.1.2` should be copied into `softphone_bind_ip` address. The `5063`

    is the SIP port the softphone application should listen to. It is hardcoded

    into `default.nix` currently.

  - Set a remote SIP account to be ``  where

    `192.168.1.1` is your `asterisk_bind_ip` (could be the same as

    `softphone_bind_ip`). Set 'softphone' as a password (also hardcoded).

  - Call to `sip:[email protected]` to talk to Lenny bot

  - Call to `sip:[email protected]` to start the outgoing GSM call.

    + After the connection is established, open Telegam chat with

      `telegram_master_nicname` and send the GSM number to call to (a simple

      oneline message). Asterisk will use GSM dongle to call this number.



Hardware notes

--------------



We use the following USB dongle:



```

*CLI> dongle show devices

ID           Group State      RSSI Mode Submode Provider Name  Model      Firmware          IMEI             IMSI             Number

dongle0      0     Free       9    0    0       Beeline        E173       11.126.85.00.209  ***************  ***************  Unknown

```



See also [somewhat outdated list of supported devices](https://github.com/bg111/asterisk-chan-dongle/wiki/Requirements-and-Limitations)



Known issues

------------



* ~~tg2sip calls stopped working properly. GSM callers hear themselves but

  can't hear the telegram side. Softphone calls work fine.~~



* `tg2sip` crashes on incoming calls :(

  https://github.com/Infactum/tg2sip/issues/63



Thirdparty issues

-----------------



* ~~https://github.com/wdoekes/asterisk-chan-dongle/issues/109~~

* ~~https://github.com/wdoekes/asterisk-chan-dongle/issues/110~~

* ~~https://github.com/wdoekes/asterisk-chan-dongle/issues/121~~

* ~~https://github.com/Infactum/tg2sip/issues/42~~

* ~~https://community.asterisk.org/t/help-translating-a-simple-peer-config-to-pjsip/86601~~

* https://github.com/wdoekes/asterisk-chan-dongle/issues/120

* Binary codec `chan_opus.so` is required by tg2sip. Consider replacing it with

  https://github.com/traud/asterisk-opus

* On top of above, we run Asterisk is as root, due to `chan_dongle` hardcodings.

* `dongleman_daemon` has to reconnect automatically in case of network failures.

  Currently it issues the error `ConnectionError: Cannot send requests while

  disconnected`.

* https://github.com/Infactum/tg2sip/issues/63



Administration hints

--------------------



### Ulaw audio operations:



* Converting 3gpp to ulaw: `./3gpp2ulaw.sh`

* Playing ulaw file: `aplay -t raw -f MU_LAW `



### Cutting last x seconds from an audio file



```sh

cutlast() {

  ffmpeg -i "$2" -ss 0 -to $(echo $(ffprobe -i "$2" -show_entries format=duration -v quiet -of csv="p=0") - "$1" | bc) -c copy "$3"

}

```



### Clearing dongle SMS messages



```sh

#!/bin/bash -x

cmds()

{

cat <