Cellular Network Infrastructure » cni-legacy » OpenBSC

{{>toc}}

h1. Welcome to Osmocom [[OpenBSC]]

This is a project aiming to create a Free Software, (A)GPL-licensed software implementations for the GSM/3GPP protocol stacks and elements.

We have started with an A-bis (plus BSC/MSC/HLR) implementation for experimentation and research purpose, but have since moved way beyond that.

What this means: [[OpenBSC]] is not just a standard BSC, but a _GSM network in a box_ software, implementing the minimal necessary parts to build a small, self-contained GSM network.

[[OpenBSC]] includes functionality normally performed by the following components of a GSM network: BSC (Base Station Controller), MSC (Mobile Switching Center), HLR (Home Location Register), AuC (Authentication Center), VLR (Visitor Location Register), EIR (Equipment Identity Register).

In addition, the Osmocom project also develops and maintains the [[osmo-sgsn]] and [[OpenGGSN]] programs for adding GPRS/EDGE capabilities.

We have started with the Siemens BS11 microBTS, mainly targetted the ip.access nanoBTS for some years, but has since been extended to support a variety of other [[BTS]] equipment like the Ericsson RBS 2000 family.  Today, most of the users and active developers work not with proprietary BTSs, but with BTSs running our [[OsmoBTS]] software, i.e. either the "sysmoBTS":http://www.sysmocom.de/products/sysmobts family of hardware or SDR based hardware with [[OsmoTRX]] like the "UmSITE":https://fairwaves.co/wp/products/.

_We are always looking for [[HardwareDonations]] of any kind of GSM / 3G related carrier equipment._

[[BlogList(format=float,recent=5,max_size=350)]]

There is also continued work on creating a Free Software / Open Source software SS7 (M3UA, SUA, SCCP, TCAP, MAP) protocol stack in Erlang, as well as a number of other side projects like the "SIMtrace":http://simtrace.osmocom.org/ protocol tracer/sniffer for (U)SIM APDUs.

h1. Overview Diagram

Please see the below overview diagram about common possible configurations of the Osmocom software.

[[Image(osmocom-gsm.png)]]

h2. Getting started

[[UnderstandingOpenBSC]] -- Where to start learning about [[OpenBSC]], what it does, and how.

h2. [[OpenBSC]] Software

* Software for running a full minimal GSM Network in a Box:

** [[OpenBSC]] -- The Free Software project implementing various parts of the GSM network

*** [[osmo-nitb]] -- A stand-alone gsm-network-in-a-box program implementing minimal subset of BSC, MSC, HLR, AuC and EIR.

**** [[osmo-nitb_VTY]] -- Reference for the interactive command line and config file

* Software utilities for BTS configuration, provisioning and the like

** [[bs11_config]] -- A small tool for configuring the BS-11 using RS232

** [[ipaccess-find]] -- A small tool to find nanoBTS in your network 

** [[ipaccess-config]] -- A small tool to set NVRAM configuration of the nanoBTS

** [[isdnsync]] -- A small tool to use the PSTN as frequency standard

* Software for running a BTS

** [[OsmoBTS]] -- A BTS implementation

** [[OsmoTRX]] -- A transceiver for [[OsmoBTS]] to use with SDR hardware

* Software for running in pure _BSC only_ mode, attaching via A/SCCP to a MSC

** [[osmo-bsc]] -- [[OpenBSC]] in BSC-only mode

** [[bsc_msc_ip]] -- A previous utility to connect to a MSC via A over IP

*** [[OpenBSCWithSCCP]] -- Howto use [[OpenBSC]] with a separate/real MSC

** [[bsc_mgcp]] -- A stupid [[MediaGatewayControlProtocol]] (MGCP) gateway

*** [[bsc_mgcp_VTY]] -- Reference for the interactive command line and config file

* Software for UMA/GAN (Unified Mobile Access)

** [[osmo-ganc]] -- [[OpenBSC]] in GANC mode

* Special purpose software for aggregating multiple A or Gb links

** [[bsc_nat]] -- a BSC NAT/Multiplexer

*** [[bsc_nat_VTY]] -- Reference for the interactive command line and config file

*** [[bsc_nat_release]] -- Release testing for the BSC NAT.

** [[osmo-gbproxy]] -- A proxy/gateway for aggregating multiple Gb links betwen BSS and SGSN

*** [[osmo-gbproxy_VTY]] -- Reference for the interactive command line and config file

** [[release-testing|Testing]] -- Comments and what makes sense to test for releases

* GPRS related software

** [[osmo-sgsn]] -- A work-in-progress SGSN

*** [[osmo-sgsn_VTY]] -- Reference for the interactive command line and config file

*** [[OpenBSC_GPRS]] -- Howto add data support to your [[OpenBSC]] setup

** [[osmo-pcu]] -- A work-in-progress RLC/MAC and PCU implementation

* [[OpenBSC]] related

*** [[cellmgr_ng]] -- The cellmgr_ng project to bring old equipment to the world of IP

*** [[simplehlr]] -- A web interface for the [[OpenBSC]] HLR database

* [[PortNumbers]] -- A list of TCP port numbers as they are used by [[OpenBSC]] and related programs

* Protocol extensions

*** [[MgcpExtensions]] -- Extensions to MGCP

* [[simulation]] -- Running [[OpenBSC]] without a GSM Basestation

* Important legal information on [[SoftwareLicensing]]

* [[meas_web]] -- Web based measurement utility for [[OpenBSC]]

h3. Information related to a specific BTS model

{{child_pages(BTS_Hardware,depth=1)}}

h3. Miscellaneous Information

* [[GSM]] -- Some links for starting to understand GSM

* [[HFC-E1|HFC-E1 Evaluation Board]] -- The E1 card we use for attaching classic E1 based A-bis links

* [[GSMStandards]] -- The specifications for GSM

* [[A5_GSM_AT_tricks]] -- A5: Authentication & Ciphering

* [[mISDN]] -- The Linux ISDN stack

* [[HandsetBugs]] -- Things we have observed during development

* [[GSM_Security]] -- The GSM security issues that we find

* [[LegalNotes]] -- Important Legal notes on operating GSM base stations

* [[FieldTests]] -- The [[OpenBSC]] field tests and their reports

h3. Howtos

* Standard configuration:

*** [[Building_OpenBSC]] -- Getting started with [[OpenBSC]] under Debian

*** [[multi-BTS_with_handover]] -- Connecting 2x BTS to a single BSC/NITB and enabling handover 

* Advanced topics:

*** [[OpenBSC_with_Asterisk]] -- A comprehensive tutorial on setting up [[OpenBSC]] with Asterisk

*** [[OpenBSC_LCR]] -- [[OpenBSC]]+LCR with Asterisk (obsolete)

*** [[OpenBSC_LCR_Ubuntu1204]] -- Short installation guide for [[OpenBSC]] with Asterisk on Ubuntu 12.04

*** [[OpenBSC_Crypto]] -- Howto add A5/x cryptography support to your [[OpenBSC]] setup

*** [[SDR_OsmoTRX_network_from_scratch]] -- Building everything from scratch for SDR based hardware with [[OsmoTRX]], [[OsmoBTS]] and [[OsmoNITB]].

* RF Topics:

*** [[cable_antenna]] -- Build new antennas for your BTS

*** [[ethernet_dummyload]] -- Use an old ethernet terminator as dummyload

*** [[10db_attenuator]] -- Turn 30mW into 3 mW

h2. Developers

<pre>

<pre>

<pre>

<pre>

*** Browse the repositories at http://git.osmocom.org/

* Mailinglist is at "* [[Jenkins|Continuous Integration efforts"httplistsgnumonksorgmailmanlistinfoopenbsc]]

* Wiki is right here ;)

* Developer conferences: [[OsmoDevCon2016]], [[OsmoDevCon2015]], [[OsmoDevCon2014]], [[OsmoDevCon2013]], [[OsmoDevCon2012]]

* [[Tasks]] -- Tasks/Internships/Junior Jobs for [[OpenBSC]] and Osmocom

* [[Devtools]] -- Various tools to find/fix errors, send patches, etc

* [[Coding_standards]] -- Coding standards

h3. Tools for developers

* [[WandelGoltermannMA10]] -- a GSM protocol analyzer ISA card

* [[TektronixK1103]] -- GSM protocol tester and analyzer

* [[PacketDump]] -- Using wireshark on PCAP files

* [[MagicSIM]] -- SIM cards where you can program the Ki

h2. News

* _OpenBSC ran many more experimental and commercial networks, but no one bothered to update this section..._

* [[OpenBSC]] was running an experimental GSM network at "CCC Camp":http://events.ccc.de/camp/2011/wiki/GSM in the Summer of 2011

* [[OpenBSC]] was running an experimental GSM network at "27c3":http://events.ccc.de/congress/2010 in December 2010

* The slides of the "25C3 presentation _Running your own GSM network_":http://events.ccc.de/congress/2008/Fahrplan/events/3007.en.html "are available":http://events.ccc.de/congress/2008/Fahrplan/attachments/1259_25C3-OpenBSC.pdf.

* The slides of the "26C3 presentation _Fuzzing GSM handsets using [[OpenBSC]]_":http://events.ccc.de/congress/2009/Fahrplan/events/3535.en.html "are available":http://events.ccc.de/congress/2009/Fahrplan/attachments/1503_openbsc_gsm_fuzzing.pdf

h2. Related projects

* "-- [[OsmocomBB]] - Free Software GSM protocol stack for mobile phones

* [http://gnuradio.org/redmine/projects/gnuradio/wiki/OpenBTS [[OpenBTS]]":http://bb.osmocom.org/]

* "The THC GSM project":http://wiki.thc.org/gsm/

* "airprobe.org":http://airprobe.org/

* "Homepage of Dr.-Ing. Joachim Goeller":http://www2.informatik.hu-berlin.de/~goeller/

h2. Thanks

* to "for funding part of the [[OpenBSC]] development

* to [http://junghanns.net":http://netzing.de] for supporting us with discounted E1 boards

* to "for funding part of the [[OpenBSC]] development

* to Kevin Redon for the osmocom logo

h2. Starting Points about trac

* About [[WikiFormatting]]

* [[TracGuide]] --  Built-in Documentation

* [http://trac.edgewall.org/ The Trac project":http://www.on-waves.com] -- Trac Open Source Project

* "Trac FAQ":http://trac.edgewall.org/wiki/TracFaq -- Frequently Asked Questions

* [[TracSupport]] --  Trac Support

For a complete list of local wiki pages, see [[TitleIndex]].