Cellular Network Infrastructure » cni-legacy » OpenBSC

[[PageOutline]]

= Welcome to 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 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).

Right now we are targeting the '''Siemens BS11 microBTS''' and '''ip.access nanoBTS''' GSM base transceiver station, but we are planning to support different [wiki:BTS] equipment in the future.

''We are looking for [wiki:HardwareDonations] of any kind of GSM / 3G related carrier equipment.''

== OpenBSC Software ==

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

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

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

    * [wiki:bsc_hack_VTY] -- Reference for the interactive command line and config file

 * Software utilities for BTS configuration, provisioning and the like

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

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

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

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

 * Software for running in pure ''BSC only'' mode, attaching via A/SCCP to a MSC

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

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

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

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

 * Special purpose software for aggregating multiple A or Gb links

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

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

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

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

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

 * GPRS related software

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

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

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

=== Information related to a specific BTS model ===

 * [wiki:BS11] -- The Siemens BS-11 microBTS

  * [wiki:BS11_Sales] -- BS-11 units are sold out by now, sorry.

  * [wiki:BS11_Package_List] -- Make sure everything is in the package

  * [wiki:BS11_Configuration] -- How to use / setup the hardware

  * [wiki:BS11_LMT] -- The local maintenance Terminal

  * [wiki:BS11_Getting_Started] -- Getting started with your BS-11

  * [wiki:BS11_Troubleshooting] -- When something doesn't work

  * [wiki:BS11_Internals] -- Details like PCB photographs

  * [wiki:E1-to-RJ45] -- Howto build your E1<>RJ45 cable

  * [wiki:Isdnsync] -- Howto use the PSTN as frequency standard

 * [wiki:nanoBTS] -- the ip.access nanoBTS

  * [wiki:nanoBTS_Models] -- Known models

  * [wiki:nanoBTS_Internals] -- Details like PCB photographs and debug port

  * [wiki:nanoBTS_multiTRX] -- Creating a nanoBTS multi-TRX setup

=== Miscellaneous Information ===

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

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

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

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

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

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

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

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

=== Howtos ===

 * Standard configuration:

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

 * Advanced topics:

   * [wiki:OpenBSC_LCR] -- OpenBSC+LCR with Asterisk

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

 * RF Topics:

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

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

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

== Developers ==

 * git checkout is available via {{{git clone git://bs11-abis.gnumonks.org/openbsc.git}}}

   * you now also need libosmocore to build openbsc: {{{git clone git://git.osmocom.org/libosmocore.git}}}

 * Mailinglist is at [http://lists.gnumonks.org/mailman/listinfo/openbsc]

 * [wiki:Tarballs] of libosmocore and OpenBSC

 * Wiki is right here ;)

=== Tools for developers ===

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

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

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

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

== News ==

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

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

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

== Related projects ==

 * [http://bb.osmocom.org/] -- OsmocomBB - Free Software GSM protocol stack for mobile phones

 * [http://gnuradio.org/trac/wiki/OpenBTS OpenBTS]

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

 * [http://airprobe.org/ airprobe.org]

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

== Thanks ==

 * to [http://netzing.de] for funding part of the OpenBSC development

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

 * to [http://www.on-waves.com] for funding part of the OpenBSC development

== Starting Points about trac ==

 * About WikiFormatting

 * TracGuide --  Built-in Documentation

 * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project

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

 * TracSupport --  Trac Support

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