public/lime-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

1.3.0

Browse source
This commit is contained in:
Ho Sy Tan 2025-06-17 16:29:28 +07:00
commit e82e57801c
21 changed files with 3477 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
*.swp
rpmbuild/

61
.gitlab-ci-files/deploy.yml Normal file
View file

@ -0,0 +1,61 @@
rocky8-deploy:
extends: .deploy
script:
- ./deploy_packages.sh rockylinux
needs:
- rocky8-package
- rocky8-test-install
rocky9-deploy:
extends: .deploy
script:
- ./deploy_packages.sh rockylinux
needs:
- rocky9-package
- rocky9-test-install
debian11-deploy:
extends: .deploy
script:
- ./deploy_packages.sh debian bullseye
needs:
- debian11-package
- debian11-test-install
debian12-deploy:
extends: .deploy
script:
- ./deploy_packages.sh debian bookworm
needs:
- debian12-package
- debian12-test-install
ubuntu18.04-deploy:
extends: .deploy
script:
- ./deploy_packages.sh ubuntu bionic
needs:
- debian12-package
- debian12-test-install
.deploy:
stage: deploy
tags: ["docker"]
only:
- master
- /^release/.*$/
before_script:
- rm -f $CI_PROJECT_DIR/build/*devel*.rpm # Remove devel packages
- cd $CI_PROJECT_DIR/build/ && for file in *; do mv "$file" $(echo "$file" | sed -e 's/[^A-Za-z0-9._+-]//g'); done || true && cd .. # Rename non standard packages
- eval $(ssh-agent -s)
- echo "$DEPLOY_USER_KEY" | tr -d '\r' | ssh-add - > /dev/null
- mkdir -p ~/.ssh && chmod 700 ~/.ssh
- echo "$DEPLOY_SERVER_HOST_KEY" >> ~/.ssh/known_hosts
- |
curl -o deploy_packages.sh --header "PRIVATE-TOKEN: ${TOOLS_REPOSITORY_TOKEN}" https://gitlab.linphone.org/api/v4/projects/368/repository/files/deploy_packages.sh/raw
- chmod +x deploy_packages.sh
after_script:
- rm -rf ~/.ssh || true
- rm -rf deploy_packages.sh || true

38
.gitlab-ci-files/package.yml Normal file
View file

@ -0,0 +1,38 @@
rocky8-package:
extends: .package
image: gitlab.linphone.org:4567/bc/public/docker/rocky8-php:$ROCKY_8_IMAGE_VERSION
script:
- make rpm
rocky9-package:
extends: .package
image: gitlab.linphone.org:4567/bc/public/docker/rocky9-php:$ROCKY_9_IMAGE_VERSION
script:
- make rpm-el9
debian11-package:
extends: .debian-package
image: gitlab.linphone.org:4567/bc/public/docker/debian11-php:$DEBIAN_11_IMAGE_VERSION
debian12-package:
extends: .debian-package
image: gitlab.linphone.org:4567/bc/public/docker/debian12-php:$DEBIAN_12_IMAGE_VERSION
ubuntu-18.04-package:
image: gitlab.linphone.org:4567/bc/public/linphone-sdk/bc-dev-ubuntu-18-04-lts-php:$UBUNTU_18_04_LTS_IMAGE_VERSION
extends: .debian-package
.debian-package:
extends: .package
script:
- make deb
.package:
tags: ["docker"]
stage: package
artifacts:
paths:
- build/*
when: always
expire_in: 1 day

44
.gitlab-ci-files/test-install.yml Normal file
View file

@ -0,0 +1,44 @@
.test-install:
tags: ["docker"]
stage: test-install
.redhat-test-install:
extends: .test-install
script:
- yum -y localinstall ./build/*.rpm
rocky8-test-install:
extends: .redhat-test-install
image: gitlab.linphone.org:4567/bc/public/docker/rocky8-php:$ROCKY_8_IMAGE_VERSION
needs:
- rocky8-package
rocky9-test-install:
extends: .redhat-test-install
image: gitlab.linphone.org:4567/bc/public/docker/rocky9-php:$ROCKY_9_IMAGE_VERSION
needs:
- rocky9-package
.debian-test-install:
extends: .test-install
script:
- apt update
- apt install -y ./build/*.deb
debian11-test-install:
extends: .debian-test-install
image: gitlab.linphone.org:4567/bc/public/docker/debian11-php:$DEBIAN_11_IMAGE_VERSION
needs:
- debian11-package
debian12-test-install:
extends: .debian-test-install
image: gitlab.linphone.org:4567/bc/public/docker/debian12-php:$DEBIAN_12_IMAGE_VERSION
needs:
- debian12-package
ubuntu-18.04-test-install:
extends: .debian-test-install
image: gitlab.linphone.org:4567/bc/public/linphone-sdk/bc-dev-ubuntu-18-04-lts-php:$UBUNTU_18_04_LTS_IMAGE_VERSION
needs:
- ubuntu-18.04-package

16
.gitlab-ci.yml Normal file
View file

@ -0,0 +1,16 @@
variables:
ROCKY_8_IMAGE_VERSION: 20241113_143521_update_php_82
ROCKY_9_IMAGE_VERSION: 20241114_161138_remove_redis
DEBIAN_11_IMAGE_VERSION: 20241112_113527_update_package_and_dependencies
DEBIAN_12_IMAGE_VERSION: 20241112_113948_update_package_and_dependencies
UBUNTU_18_04_LTS_IMAGE_VERSION: 2023_01_24_rebuild_image
include:
- '.gitlab-ci-files/package.yml'
- '.gitlab-ci-files/test-install.yml'
- '.gitlab-ci-files/deploy.yml'
stages:
- package
- test-install
- deploy

145
CHANGELOG.md Normal file
View file

@ -0,0 +1,145 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.3.0] - 2024-10-13
### Added
- support for PQ algorithm based network (C25519/K512)
- dedicated log directory
- multiple base algorithm provided on one URL
## [1.2-2] - 2024-05-29
### Modified
- KEM OPk are not signed anymore
- keep using 'From' header to connect to another lime server (so we don't need to update them all at once)
## [1.2-1] - 2024-05-01
### Added
- Support a specific header field for lime username (usage of From is still supported)
## [1.2-0] - 2024-04-24
### Added
- Log rotation
## [1.1-0] - 2023-12-30
### Modified
- Publish under GNU Affero Public Licence version 3
## [1.0-36] - 2023-11-06
### Modified
- Key bundle request split to avoid locking Users table (minimize deadlock) - thanks Jacob
## [1.0-35] - 2023-03-21
### Modified
- case insensitive access to HTTP header fields name.
## [1.0-34] - 2023-02-22
### Modified
- Access log get a dedicated log file set by lime\_accessLogFile in conf file
- improve mysqli error reporting
## [1.0-33] - 2022-07-19
### Modified
- bad 'From' in request detected earlier to improve performances.
## [1.0-32] - 2021-10-21
### Modified
- Configure different apache\_conf\_path depending on targeted ditribution. We assume that we use the Apache of the system for el8
## [1.0-30] - 2021-08-13
### Added
- Foreign server can authenticate using Http Digest
## [1.0-29] - 2021-04-20
### Added
- Log rotation
- Debian/Ubuntu packaging
## [1.0-28] - 2021-02-11
### Added
- Check PHP version to be at least 7.1
### Fix
- Database creation scripts
- Mysql error reporting
- Auth realm/sip domain may differ
## [1.0-27] - 2020-11-05
### Added
- Number of key bundle request can be limited
## [1.0-26] - 2020-10-12
### Added
- Digest authentication realm can be fetched from request if not forced in config file
### Fix
- Limit friends servers requests to getPeerBundle
## [1.0-25] - 2020-09-10
### Added
- multidomain management: server can forward a key bundle request to a foreign domain lime server
## [1.0-24] - 2020-07-15
### Removed
- rpm dependency on rh-php71. Warning: user must now install manually some packages providing php and php-mysqlnd
## [1.0-23] - 2020-07-06
### Fixed
- log files when deploying 2 servers
## [1.0-22] - 2020-05-30
### Added
- client authentication using TLS certificates.
## [1.0-21] - 2020-05-25
### Added
- limit resources allocated to a user accont(devices per account, OPKs per device)
## [1.0-20] - 2020-03-23
### Added
- flexible selection of configuration file to run several servers on one deployment
## [1.0-18] - 2020-01-09
### Fixed
- multiple digest auth support
- non alphanumerical username support
## [1.0-16] - 2019-11-04
### Added
- non alphanumerical username support
### Fixed
- SHA256 digest auth again
## [1.0-15] - 2019-11-04
### Fixed
- race condition on table lock
- SHA256 digest auth
### Changed
- authentication database structure
## [1.0-14] - 2019-03-15
### Fixed
- Digest auth having cleartext password in DB
## [1.0-13] - 2019-03-11
### Added
- user not found error on getSelfOPKs
- https config in rpm
### Fixed
- rpm generation
## [1.0-11] - 2019-03-08
### Added
- Atomic user publishing
- republishing
- php script to initialise the database
### Fixed
- rpm generation
### Security
- Authentication hash comparison function
## [1.0-10] - 2019-02-08
### Added
- Initial release.

661
COPYING Normal file
View file

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

100
Makefile Normal file
View file

@ -0,0 +1,100 @@
OUTPUT_DIR = ${CURDIR}
## Make sure git is happy with /home/bc before fetching the tag description
$(shell git config --global --add safe.directory /home/bc)
GIT_DESCRIBE = $(shell sh -c "git describe --long" 2>/dev/null)
DESCRIBE_PARTS = $(subst -, ,$(GIT_DESCRIBE))
VERSION_TAG = $(word 1,$(DESCRIBE_PARTS))
STATUS_TAG = $(word 2,$(DESCRIBE_PARTS))
STATUS_DISTANCE_TAG = $(word 3,$(DESCRIBE_PARTS))
COMMIT_HASH_TAG = $(word 4,$(DESCRIBE_PARTS))
CLEAN_COMMIT_HASH_TAG = $(COMMIT_HASH_TAG:g%=%)
package-semvers:
mkdir -p build
cp lime-server.spec lime-server.spec.run
echo "OUT $(OUTPUT_DIR)"
echo "GIT_DESCRIBE $(GIT_DESCRIBE)"
echo "DESCRIBE_PARTS $(DESCRIBE_PARTS)"
echo "VERSION TAG $(VERSION_TAG)"
sed -i 's/MAKE_FILE_VERSION_SEARCH/$(VERSION_TAG)/g' $(CURDIR)/lime-server.spec.run
ifneq (,$(filter alpha beta,$(STATUS_TAG)))
sed -i 's/MAKE_FILE_BUILD_NUMBER_SEARCH/0.$(STATUS_TAG).$(STATUS_DISTANCE_TAG)+$(CLEAN_COMMIT_HASH_TAG)/g' $(CURDIR)/lime-server.spec.run
else
sed -i 's/MAKE_FILE_BUILD_NUMBER_SEARCH/1/g' $(CURDIR)/lime-server.spec.run
endif
cleanup-package-semvers:
rm lime-server.spec.run
package-common:
echo "OUT $(OUTPUT_DIR)"
echo "GIT_DESCRIBE $(GIT_DESCRIBE)"
echo "DESCRIBE_PARTS $(DESCRIBE_PARTS)"
rm -rf $(OUTPUT_DIR)/lime-server
mkdir $(OUTPUT_DIR)/lime-server
mkdir -p $(OUTPUT_DIR)/rpmbuild/SPECS
mkdir -p $(OUTPUT_DIR)/rpmbuild/SOURCES
cp src/*.php $(OUTPUT_DIR)/lime-server/
cp src/lime-server.conf $(OUTPUT_DIR)/lime-server/
cp README.md $(OUTPUT_DIR)/lime-server/
cp CHANGELOG.md $(OUTPUT_DIR)/lime-server/
cp COPYING $(OUTPUT_DIR)/lime-server/
mkdir -p $(OUTPUT_DIR)/lime-server/httpd
cp httpd/lime-server.conf $(OUTPUT_DIR)/lime-server/httpd
mkdir -p $(OUTPUT_DIR)/lime-server/logrotate
cp logrotate/lime-server.conf $(OUTPUT_DIR)/lime-server/logrotate
cp lime-server.spec.run $(OUTPUT_DIR)/rpmbuild/SPECS/lime-server.spec
tar cvf lime-server.tar.gz -C $(OUTPUT_DIR) lime-server
mv lime-server.tar.gz $(OUTPUT_DIR)/rpmbuild/SOURCES/lime-server.tar.gz
package-end-common:
rm -rf $(OUTPUT_DIR)/lime-server
rm -rf $(OUTPUT_DIR)/rpmbuild/SPECS $(OUTPUT_DIR)/rpmbuild/SOURCES $(OUTPUT_DIR)/rpmbuild/SRPMS $(OUTPUT_DIR)/rpmbuild/BUILD $(OUTPUT_DIR)/rpmbuild/BUILDROOT
rpm-only:
rpmbuild -v -bb --define 'dist .el8' --define '_topdir $(OUTPUT_DIR)/rpmbuild' --define "_rpmdir $(OUTPUT_DIR)/rpmbuild" $(OUTPUT_DIR)/rpmbuild/SPECS/lime-server.spec
@echo "📦✅ RPM Package Created"
@echo "🧹 Cleanup"
mv rpmbuild/*/*.rpm build/.
rm -r rpmbuild
rpm-el9-only:
rpmbuild -v -bb --define 'dist .el9' --define '_topdir $(OUTPUT_DIR)/rpmbuild' --define "_rpmdir $(OUTPUT_DIR)/rpmbuild" $(OUTPUT_DIR)/rpmbuild/SPECS/lime-server.spec
@echo "📦✅ RPM Package Created"
@echo "🧹 Cleanup"
mv rpmbuild/*/*.rpm build/.
rm -r rpmbuild
deb-only:
rpmbuild -v -bb --with deb --define '_topdir $(OUTPUT_DIR)/rpmbuild' --define "_rpmfilename tmp.rpm" --define "_rpmdir $(OUTPUT_DIR)/rpmbuild" $(OUTPUT_DIR)/rpmbuild/SPECS/lime-server.spec
fakeroot alien -g -k --scripts $(OUTPUT_DIR)/rpmbuild/tmp.rpm
rm -r $(OUTPUT_DIR)/rpmbuild
rm -rf $(OUTPUT_DIR)/*.orig
sed -i 's/Depends:.*/Depends: $${shlibs:Depends}, php, php-xml, php-mysql/g' $(OUTPUT_DIR)/bc-lime-server*/debian/control
cd `ls -rt $(OUTPUT_DIR) | tail -1` && dpkg-buildpackage --no-sign
@echo "📦✅ DEB Package Created"
@echo "🧹 Cleanup"
ls -d */ | cut -f1 -d'/' | grep bc-lime-server | xargs rm -rf
rm -rf lime-server
ls bc-lime-server* | grep -v "\.deb" | xargs rm
mv *.deb build/.
rpm-el9: package-semvers package-common rpm-el9-only cleanup-package-semvers package-end-common
rpm: package-semvers package-common rpm-only cleanup-package-semvers package-end-common
deb: package-semvers package-common deb-only cleanup-package-semvers package-end-common
.PHONY: all

193
README.md Normal file
View file

@ -0,0 +1,193 @@
PHP Authenticated Lime server
==============================
Disclaimer
-----------
The secure access to this server is based on authentication credentials provided externally,
it is designed to be used in conjunction with flexisip but may be used with any
other login/password provider as long as the login follow the following rule:
- username and realm are combined to authentify the lime device id which is expected to be the GRUU
so it is checked that the lime device id matches:
`/^sip:<username>@<realm>;gr=*/`
Requirements
------------
The server requires a functional web server serving php script located (by default) in */opt/belledonne-communications/share/lime-server/lime-server.php*
The server requires reading access to an authentication database (holding username and password hash - see configuration file for details).
The server requires a database read/write access, the tables content details is :
Users table:
- Uid: as primary key (internal use)
- UserId: shall be the GRUU
- Ik: Identity key - EDDSA public key
- SPk: the current signed pre-key - ECDH public key
- SPk_sig: current SPk public key signed with Identity key
- SPk_id: id for SPk provided and internally used by client) - 4 bytes unsigned integer
OPk table:
- id: as primary key (internal use)
- Uid: Id of user owning that key, a foreign key
- OPk: the public key (ECDH public key)
- OPk_id: id for OPk provided and internally used by client - 4 bytes unsigned integer
Requests table:
- source: the source UserId of the bundle request
- target: the target UserId of the bundle request
- at: timestamp set when the request is served
Config table: holds one row: version
- Name: the parameter name (version)
- Value: the parameter value (db version scheme)
Security Considerations
-----------------------
Recommendations:
- Use updated PHP version installed from a reliable source
- Serve the php script on HTTPS connection only, be sure the TLS configuration is correct and does not allow weak cipher schemes
- The database access must use a dedicated user with access allowing only the needed access rights: read on the Config table, read/write on the Users and OPk tables
- The lime-createBase.php shall be deleted after use or at least not served by the web server (It is protected against execution not in command line but better be safe than sorry)
Notes:
- This server does not rely on any php framework but use core PHP functionnalities only and mysqli PHP module, this keeps it simple to update and limit the attack surface.
- All database access in this scripts use mysqli prepared statements.
Foreign Domain support
----------------------
When a server receives a key bundle request including users on another domain(refered here as foreign domain), it has the possibility to request them to the foreign domain lime server.
Ex:
- the local server serves the domain sip.example.org and receive a key bundle request for user1@sip.foreign-example.org
- the local server requests to the sip.foreign-example.org lime server the key bundle, and then forward the response to the original requester
To enable this functionnality, the configuration on the local server must:
- have an URL to contact the lime server managing sip.foreign-example.org domain, provide a way to authenticate on it
- the foreign-example.org lime server must be configured to accept requests from sip.example.org lime server and authenticate it
One server may authenticate itself to another one using:
- TLS Client certificate
The client certificate must have a SAN (CN is deprecated but accepted) holding the server username accepted by the other server. Ex: sip.example.org will authenticate on a foreign lime server presenting a certificate with a SAN holding the a username accepted by the foreign server. The foreign server must be configured to accept this certificate(so its CA can verify it) and accept the username present in the SAN.
- HTTP digest authentication:
The digest auth uses SHA-256 auth.
- On the local server, set the sha-256(user:realm:password) in the configuration array holding the foreign server url and credentials
- On the foreign server, set the same hash in the configuration array holding the list of external domains server authorized to make key bundle requests
Note: You do not really need to know the password used in the digest auth, just put the same hash(a 64 characters hexadecimal string) in both configuration file. If you do need to know the password - there shall not be any good reason for that - the username is set configuration file (the local domain is used by default) and the realm is the foreign domain one.
Deployment
----------
- complete the configuration file */etc/lime-server/lime-server.conf* (see configuration file itself and the configuration section of this readme for details
The script is served at *SERVER_URL/lime-server/lime-server.php*, configure your clients accordingly
User Authentication
-------------------
This server supports two clients authentication methods, which are enabled by default.
### TLS client certificate
When this method is enabled, if your web server is correctly configured,
for example using Apache, in the VirtualHost section:
`SSLVerifyClient optional` or `SSLVerifyClient require`
`SSLVerifyDepth 10`
`SSLOptions +StdEnvVars`
`SSLCACertificateFile <path to your enabled certificate chain`
`SSLCARevocationFile <path to your revoked client certificate`
The client identity (its sip:uri) is expected to be provided in subject altName DNS entry but also fallback on subject Common Name
if no identity matching the provided lime userid (the GRUU) is find in the altName DNS entries.
### Digest authentication
When this option is enabled the lime-server configuration file must hold:
`AUTH_REALM` : the realm to perform authentication on. If this is not defined, the realm is fetched from the HTTP header,
allowing for multiple domains to run on one server.
`AUTH_NONCE_KEY` : a secret key to generate the nonce used by the digest authentication scheme
`AUTH_QUERY`: a sql query to reach the user/password DB.
Digest authentication supports MD5 and SHA256 hashes
When TLS client certificates is enabled but optional and the client fails to present a certificate,
if the digest authentication mode is enabled, the user will be given the opportunity to log in using the digest scheme.
Invalid, revoked certificate or mismatch between certificate subject CN and lime user name (given in the `From` http header)
will lead to a connection rejection without trying to log using the digest scheme.
Configuration
-------------
At install the server is not functionnal, to set it up, in the configuration file, you must:
- activate a subset of the supported base algorithm (from C25519, C448 and C25519K512)
- set all the database access codes : lime database and user/password db (if digest authentication is enabled)
- create the lime database and tables according to your selected base algorithms :
- either using the php script provided (prefered method):
- first complete the configuration file. The user/password given in the configuration must be granted with database creation rights
- `cd /opt/belledonne-communications/share/lime-server && php lime-createBase.php --curve [C25519|C448|C25519K512]` This step must be run for each of the enabled base algorithm
- lime-createBase.php use the default */etc/lime-server/lime-server.conf*, you can provide another one
using *--config_path <path to your configurationfile>* option.
- set in the configuration file a user with mysql access restricted as indicated in the security considerations sections.
- or running the SQL code given below with a user granted to create databases.
- set the `AUTH_NONCE_KEY` if the digest authentication scheme is enabled
- Configure the optional features, see the config file comments for details.
WARNING: external domain and key bundle request limitation interact in a tricky way. If you enable both, make sure you understand what you're doing.
See the configuration file for details on this.
```sql
START TRANSACTION;
CREATE TABLE IF NOT EXISTS `Users` (
`Uid` INTEGER NOT NULL AUTO_INCREMENT,
`UserId` TEXT COLLATE utf8_bin NOT NULL,
`Ik` BLOB NOT NULL,
`SPk` BLOB DEFAULT NULL,
`SPk_sig` BLOB DEFAULT NULL,
`SPk_id` INTEGER UNSIGNED DEFAULT NULL,
PRIMARY KEY(`Uid`),
INDEX(UserId(100))
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
CREATE TABLE IF NOT EXISTS `OPk` (
`id` INTEGER NOT NULL AUTO_INCREMENT,
`Uid` INTEGER NOT NULL,
`OPk` BLOB NOT NULL,
`OPk_id` INTEGER UNSIGNED NOT NULL,
PRIMARY KEY(`id`),
FOREIGN KEY(`Uid`) REFERENCES Users(`Uid`) ON UPDATE CASCADE ON DELETE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
CREATE TABLE IF NOT EXISTS Requests (
`source` TEXT NOT NULL,
`target` TEXT NOT NULL,
`at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
CREATE TABLE IF NOT EXISTS `Config` (
`Name` VARCHAR(20) COLLATE utf8_bin DEFAULT NULL,
`Value` INTEGER NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
INSERT INTO `Config` (`Name`, `Value`) VALUES
('version', 1),
CREATE EVENT clean_requests ON SCHEDULE EVERY 1 WEEK DO
DELETE FROM Requests WHERE at < DATE_SUB(NOW(), INTERVAL 2 WEEK);
COMMIT;
```
Migrate to version 1.3 and above from previous versions
-------------------------------------------------------
See README.update.md
Package
--------
See README.packaging.md

41
README.packaging.md Normal file
View file

@ -0,0 +1,41 @@
PHP Authenticated Lime server
==============================
RPM Packaging
-------------
To build a rpm package on rocky8:
`make rpm`
To build a rpm package with docker:
`docker run -v $PWD:/home/bc -it -w /home/bc gitlab.linphone.org:4567/bc/public/docker/rocky8-php:20241113_143521_update_php_82 make rpm`
The lime-server rpm package can be found in build/bc-lime-server*.rpm
To build a rpm package on rocky9:
`make rpm-el9`
To build a rpm package with docker:
`docker run -v $PWD:/home/bc -it -w /home/bc gitlab.linphone.org:4567/bc/public/docker/rocky9-php:20241114_161138_remove_redis make rpm-el9`
The lime-server rpm package can be found in build/bc-lime-server*.rpm
Debian/Ubuntu Packaging
-----------------------
To build a dev package on debian10, with alien installed run as root:
`make deb`
To build a deb package with docker:
`docker run -v $PWD:/home/bc -it gitlab.linphone.org:4567/bc/public/flexisip/bc-dev-debian:10 make deb`
or to build it for ubuntu 18
`docker run -v $PWD:/home/bc -it gitlab.linphone.org:4567/bc/public/flexisip/bc-dev-ubuntu:18.04 make deb`
The lime-server deb package can be found in rpmbuild/DEBS/x86_64/bc-lime-server*.deb

30
README.update.md Normal file
View file

@ -0,0 +1,30 @@
PHP Authenticated Lime server
==============================
From version <1.3 to 1.3(released october 2024) or above
---------------------------------------------------------
Version 1.3 received a modification regarding the path used to store log files:
- log files are stored in a dedicated directory to fix a logrotate bug on access rights
- log file names are not dependants on base algorithm
Updating from a version <1.3 you will loose all the previous server log. If you intend to keep them, make a copy if of
*/var/opt/belledonne-communications/log/\*lime\*.log* in a safe place before proceeding to the update.
Update your configuration files:
You can either just adjust to the new directory:
```
sudo sed -i 's/\/var\/opt\/belledonne-communications\/log\//\/var\/opt\/belledonne-communications\/log\/lime-server\/`/g' /etc/logrotate.d/lime-server.conf
sudo sed -i 's/\/var\/opt\/belledonne-communications\/log\//\/var\/opt\/belledonne-communications\/log\/lime-server\/`/g' /etc/lime-server/lime-server.conf
```
This will set the storage of your log files to the dedicated directory
or modify by hand in your configuration files (*/etc/logrotate.d/lime-server.conf* and */etc/lime-server/lime-server.conf" the paths to your log files. New default locations are (valid for any base algorithm selected):
*/var/opt/belledonne-communications/log/lime-server/lime.conf*
*/var/opt/belledonne-communications/log/lime-server/access-lime.conf*
*/var/opt/belledonne-communications/log/lime-server/lime-db.conf*
If your installation use lime logs to perform fail2ban inspection, do not forget to update your configuration

9
httpd/lime-server.conf Normal file
View file

@ -0,0 +1,9 @@
# this alias uses the default /etc/lime-server/lime-server.conf configuration file
Alias /lime-server /opt/belledonne-communications/share/lime-server
<Directory /opt/belledonne-communications/share/lime-server/>
Options FollowSymLinks MultiViews
AllowOverride None
Require all granted
</Directory>

110
lime-server.spec Normal file
View file

@ -0,0 +1,110 @@
%define build_number MAKE_FILE_BUILD_NUMBER_SEARCH
# apache username/conf path selection
%bcond_with deb
%if %{with deb}
%define web_user www-data
%define apache_conf_path /etc/apache2/conf-available
%else
%define web_user apache
%if "%{?dist}" == ".el7"
%define apache_conf_path /opt/rh/httpd24/root/etc/httpd/conf.d
%else
%define apache_conf_path /etc/httpd/conf.d
%endif
%endif
Name: bc-lime-server
Version: MAKE_FILE_VERSION_SEARCH
Release: %{build_number}%{?dist}
Summary: Lime key PHP server.
Group: Applications/Communications
License: GPL
URL: http://www.linphone.org
Source0: lime-server.tar.gz
# dependencies
# The lime server need a http server (config scripts are provided for apache server), php and php-mysqlnd package installed.
# Any version shall do it but forcing the rh-phpXX version decrease flexibility on the target machine
# as the rh-php packets do not provide 'php' but 'rh-phpXX'.
%description
PHP server providing online Liphone Instant Messaging Encryption (LIME) keys storage to allow asynchronous secure sessions establishment.
%prep
%setup -n lime-server
%install
rm -rf "$RPM_BUILD_ROOT"
mkdir -p "$RPM_BUILD_ROOT/opt/belledonne-communications/share/lime-server"
cp -R *.php "$RPM_BUILD_ROOT/opt/belledonne-communications/share/lime-server"
cp -R README* "$RPM_BUILD_ROOT/opt/belledonne-communications/share/lime-server"
cp -R CHANGELOG* "$RPM_BUILD_ROOT/opt/belledonne-communications/share/lime-server"
mkdir -p "$RPM_BUILD_ROOT/etc/lime-server"
mkdir -p $RPM_BUILD_ROOT%{apache_conf_path}
cp lime-server.conf "$RPM_BUILD_ROOT/etc/lime-server"
cp httpd/lime-server.conf "$RPM_BUILD_ROOT%{apache_conf_path}"
#log files, must be declared as ghost in the file section so they are removed when the package is uninstalled
mkdir -p "$RPM_BUILD_ROOT/var/opt/belledonne-communications/log/lime-server"
touch "$RPM_BUILD_ROOT/var/opt/belledonne-communications/log/lime-server/lime-db.log"
touch "$RPM_BUILD_ROOT/var/opt/belledonne-communications/log/lime-server/lime.log"
touch "$RPM_BUILD_ROOT/var/opt/belledonne-communications/log/lime-server/access-lime.log"
mkdir -p $RPM_BUILD_ROOT/etc/logrotate.d
cp logrotate/lime-server.conf "$RPM_BUILD_ROOT/etc/logrotate.d"
%postun
which setsebool > /dev/null 2>&1
if [ $? -eq 0 ] ; then
semanage fcontext -d -t httpd_log_t "/var/opt/belledonne-communications/log/lime-server(/.*)?" 2>/dev/null || :
#Applying selinux modifications on uninstall. Not Applying them on upgrade as they will be by new package
if [ $1 == 0 ] ; then
restorecon -R /var/opt/belledonne-communications/log/lime-server || :
fi
fi
%posttrans
# if selinux is installed on the system (even if not enabled)
which setsebool > /dev/null 2>&1
if [ $? -eq 0 ] ; then
setsebool -P httpd_can_network_connect_db on || :
semanage fcontext -a -t var_log_t /var/opt/belledonne-communications/log || :
semanage fcontext -a -t httpd_log_t "/var/opt/belledonne-communications/log/lime-server(/.*)?" || :
restorecon /var/opt/belledonne-communications/log || :
restorecon -R /var/opt/belledonne-communications/log/lime-server || :
fi
%files
/opt/belledonne-communications/share/lime-server/*.php
/opt/belledonne-communications/share/lime-server/README*
/opt/belledonne-communications/share/lime-server/CHANGELOG*
%config(noreplace) /etc/lime-server/lime-server.conf
%config(noreplace) %{apache_conf_path}/lime-server.conf
%config(noreplace) /etc/logrotate.d/lime-server.conf
# the dir directive force the creation of this dir at install if it does not already exists
# and it is removed if empty at uninstall
%dir %attr(744, %{web_user}, %{web_user}) /var/opt/belledonne-communications/log/lime-server
%attr(644, %{web_user}, %{web_user}) /var/opt/belledonne-communications/log/lime-server/lime-db.log
%attr(644, %{web_user}, %{web_user}) /var/opt/belledonne-communications/log/lime-server/lime.log
%attr(644, %{web_user}, %{web_user}) /var/opt/belledonne-communications/log/lime-server/access-lime.log
%clean
rm -rf $RPM_BUILD_ROOT
%changelog
* Mon Oct 14 2024 Johan Pascal <johan.pascal@belledonne-communications.com>
- manage several curves directly in one server using the same URL
* Fri Apr 26 2024 Peio Rigaux <peio.rigaux@belledonne-communications.com>
- Set a directory exclusively for the lime-server, in order to fix selinux and logrotate issues. Tag belledonne log dir to var_log_t, thus not relying on Flexisip to do that
* Thu Oct 21 2021 Peio Rigaux <peio.rigaux@belledonne-communications.com>
- Configure different apache_conf_path depending on targeted ditribution. We assume that we use the Apache of the system for el8
* Sun Mar 22 2020 Johan Pascal <johan.pascal@belledonne-communications.com>
- get configuration file path from server config, run two servers on curves 25519 and 448 using the same script
* Wed Feb 06 2019 Johan Pascal <johan.pascal@belledonne-communications.com>
- Initial RPM release.

10
logrotate/lime-server.conf Normal file
View file

@ -0,0 +1,10 @@
/var/opt/belledonne-communications/log/lime-server/access-lime*.log {
missingok
notifempty
delaycompress
}
/var/opt/belledonne-communications/log/lime-server/lime*.log {
missingok
notifempty
delaycompress
}

24
scripts/util/util_git_push.sh Executable file
View file

@ -0,0 +1,24 @@
#!/bin/bash
################################################################################
# Intended use: Compile and extract software packages
#
# Notes: This script support Linux Bash shell script only
# Install Bash from https://www.gnu.org/software/bash/
#
# Copyright (C) 2015 - 2025, CT129 Dev Team <dev@ct129.com>
################################################################################
export GIT_BRACNH="master"
export TIMESTAMP=`date +"%Y-%m-%d %H:%M:%S"`
export SCRIPT=$(readlink -f "$0")
export SCRIPT_PATH=$(dirname "$SCRIPT")
export SRC_DIR=${SCRIPT_PATH}/../..
cd ${SRC_DIR}
git add .
git commit -m "${TIMESTAMP}"
git push -u origin ${GIT_BRACNH}
################################################################################
# BASH SCRIPT ON LINUX/UNIX - END
################################################################################

28
scripts/util/util_git_release.sh Executable file
View file

@ -0,0 +1,28 @@
#!/bin/bash
################################################################################
# Intended use: Compile and extract software packages
#
# Notes: This script support Linux Bash shell script only
# Install Bash from https://www.gnu.org/software/bash/
#
# Copyright (C) 2015 - 2025, CT129 Dev Team <dev@ct129.com>
################################################################################
export GIT_BRACNH="master"
export GIT_TAG="1.3.0-20250617"
export TIMESTAMP=`date +"%Y-%m-%d %H:%M:%S"`
export SCRIPT=$(readlink -f "$0")
export SCRIPT_PATH=$(dirname "$SCRIPT")
export SRC_DIR=${SCRIPT_PATH}/../..
cd ${SRC_DIR}
git add .
git commit -m "${TIMESTAMP}"
git tag -d ${GIT_TAG}
git push origin :refs/tags/${GIT_TAG}
git tag -a ${GIT_TAG} -m ${GIT_TAG}
git push --tags
################################################################################
# BASH SCRIPT ON LINUX/UNIX - END
################################################################################

410
src/authenticated_lime.php Normal file
View file

@ -0,0 +1,410 @@
<?php
/*
authenticated_lime.php
@copyright Copyright (C) 2018-2024 Belledonne Communications SARL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
include "lime.php";
function auth_get_db_conn() {
if (USE_PERSISTENT_CONNECTIONS) {
$conn = mysqli_connect('p:' . AUTH_DB_HOST, AUTH_DB_USER, AUTH_DB_PASSWORD, AUTH_DB_NAME);
} else {
$conn = mysqli_connect(AUTH_DB_HOST, AUTH_DB_USER, AUTH_DB_PASSWORD, AUTH_DB_NAME);
}
return $conn;
}
// this function applies the same conversion performed using
// the list of unescaped character defined in get_sip_uri_username_noescapes()
// in belle-sip/src/belle_sip_utils.c
function username_escape($username) {
$unescaped_chars = "0123456789AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"; // alphanums are ok
$unescaped_chars .= "-_.!~*'()"; // marks
$unescaped_chars .= "&=+$,;?/"; //user-unreserved
$escaped_username = '';
$username_len = strlen($username);
for ($i=0; $i < $username_len; $i++) {
if (strpos($unescaped_chars, $username[$i]) === false) {
$escaped_username .= rawurlencode($username[$i]); // current char is not in the list, convert it using rawurlencode (RFC3986)
} else { // current char is in the list, leave it as it is
$escaped_username .= $username[$i];
}
}
return $escaped_username;
}
// Nonce are one-time usage, in order to avoid storing them in a table
// The nonce is built using:
// - timestamp : nonce is valid for MIN_NONCE_VALIDITY_PERIOD seconds at minimum and twice it at maximum (our goal is one time usage anyway, typical value shall be 10 )
// - request content : the response uses only the URI which would always be the same php script but we use
// the content of the request so a replay is not devastating (it would just be an actual replay, not a different command to server)
// - secret key : avoid an attacker to be able to generate a valid nonce
function auth_get_valid_nonces() {
$request = file_get_contents('php://input');
$time = time();
$time -= $time%MIN_NONCE_VALIDITY_PERIOD; // our nonce will be valid at leat MIN_NONCE_VALIDITY_PERIOD seconds and max twice it, so floor the timestamp
return array(
hash_hmac("sha256", $time.':'.$request, AUTH_NONCE_KEY),
hash_hmac("sha256", $time-MIN_NONCE_VALIDITY_PERIOD.':'.$request, AUTH_NONCE_KEY));
}
function request_authentication($realm = "sip.example.org", $username=null, $domain=null, $foreign_username=null) {
$has_md5 = false;
$has_sha256 = false;
if ($foreign_username != null) { // foreign username passwords are stored in the configuration file, SHA-256 only is supported
$has_sha256 = true;
} else {
if ($username != null) {
// Get the password/hash from database to include only available password hash in the authenticate header
$db = auth_get_db_conn();
$stmt = $db->prepare(AUTH_QUERY);
if (!$stmt) {
lime_log (LogLevel::ERROR, "Unable to execute ".AUTH_QUERY.".\nDebugging errno: " . $db->errno . "\nDebugging error: " . $db->error . "\n");
$has_md5 = true;
$has_sha256 = true;
} else {
if ($stmt->param_count == 1) {
$stmt->bind_param('s', $username); // compatibility with older config files: domain is not included in the query
} else {
$stmt->bind_param('ss', $username, $domain);
}
$stmt->execute();
if ($query_result = $stmt->get_result()) {
while ($row = $query_result->fetch_assoc()) {
$algorithm = $row['algorithm'];
if ($algorithm == 'CLRTXT') {
lime_access_log(LogLevel::DEBUG, "User " . $username. " has clear text password in db \n");
$has_md5 = true;
$has_sha256 = true;
break; // with clear text password, we can reconstruct MD5 or SHA256 hash, don't parse anything else from base
} elseif ($algorithm == 'MD5' ) {
lime_access_log(LogLevel::DEBUG, "User " . $username. " has md5 password in db \n");
$has_md5 = true;
} elseif ($algorithm == 'SHA-256') {
lime_access_log(LogLevel::DEBUG, "User " . $username. " has sha256 password in db \n");
$has_sha256 = true;
} else {
lime_access_log(LogLevel::WARNING, "User " . $username. " uses unrecognised hash algorithm ".$algorithm." to store password in db \n");
}
}
}
$stmt->close();
}
$db->close();
} else { // we don't have the username authorize both MD5 and SHA256
$has_md5 = true;
$has_sha256 = true;
}
}
if (($has_md5 || $has_sha256) == false) {
lime_access_log(LogLevel::WARNING, "User " . $username. " not found in db upon request_authentification\n");
// reply anyway with both hash authorized
$has_md5 = true;
$has_sha256 = true;
}
http_response_code(401);
if ($has_md5 == true) {
header('WWW-Authenticate: Digest realm="' . $realm.
'",qop="auth",algorithm=MD5,nonce="' . auth_get_valid_nonces()[0] . '",opaque="' . md5($realm) . '"');
}
if ($has_sha256 == true) {
header('WWW-Authenticate: Digest realm="' . $realm.
'",qop="auth",algorithm=SHA-256,nonce="' . auth_get_valid_nonces()[0] . '",opaque="' . md5($realm) . '"',false);
}
exit();
}
// when foreign username is not null, credentials are provided from the configuration file
function authenticate($auth_digest, $realm = "sip.example.org", $domain = 'sip.example.org', $foreign_username = null, $foreign_hash = null) { // realm is used to perform the auth, but the user DB should be indexed using the domain, they are likely to be the same
// Parse the client authentication data
preg_match_all('@(?i)(realm|username|nonce|uri|nc|cnonce|qop|response|opaque|algorithm)=[\'"]?([^\'",]+)@', $auth_digest, $a);
$data = array_combine($a[1], $a[2]);
$username = $data['username'];
// Is the nonce valid?
$valid_nonces = auth_get_valid_nonces();
if (!hash_equals($valid_nonces[0], $data['nonce']) && !hash_equals($valid_nonces[1], $data['nonce'])) {
lime_access_log(LogLevel::DEBUG, "User " . $username. " tried to log using invalid nonce");
return false;
}
// check that the authenticated URI and server URI match
if($data['uri'] != $_SERVER['REQUEST_URI']) {
lime_access_log(LogLevel::DEBUG, "User " . $username. " tried to log using unmatching URI in auth and server request");
return false;
}
// Check opaque is correct(even if we use a fixed value: md5($realm))
if(!hash_equals(md5($realm), $data['opaque'])) {
lime_access_log(LogLevel::DEBUG, "User " . $username. " tried to log using invalid auth opaque value");
return false;
}
// for foreign servers, credentials are always using SHA-256 and A1 is provided
if (isset($foreign_username) && isset($foreign_hash)) {
$hash_algo = 'sha256';
$A1 = $foreign_hash;
} else {
// Get the password/hash from database
$db = auth_get_db_conn();
$stmt = $db->prepare(AUTH_QUERY);
if (!$stmt) {
lime_log(LogLevel::ERROR, "Unable to execute ".AUTH_QUERY.".\nDebugging errno: " . $db->errno . "\nDebugging error: " . $db->error . "\n");
return false;
}
if ($stmt->param_count == 1) {
$stmt->bind_param('s', $username); // compatibility with older config files: domain is not included in the query
} else {
$stmt->bind_param('ss', $username, $domain);
}
$stmt->execute();
// Default requested to MD5 if not specified in header
if (array_key_exists('algorithm', $data)) {
$requested_algorithm = $data['algorithm'];
} else {
$requested_algorithm = 'MD5';
}
$password = null;
if ($query_result = $stmt->get_result()) {
while ($row = $query_result->fetch_assoc()) {
$password = $row['password'];
$algorithm = $row['algorithm'];
if ($algorithm == 'CLRTXT') {
lime_access_log(LogLevel::DEBUG, "User " . $username. " using clear text password from db \n");
break; // with clear text password, we can reconstruct MD5 or SHA256 hash, don't parse anything else from base
} elseif ($algorithm == $requested_algorithm ) {
lime_access_log(LogLevel::DEBUG, "User " . $username. " using ". $row['algorithm'] ." password from db \n");
break; // we found the requested hash in base, don't parse anything else
} else { // algo used to store the password in base won't allow to reconstruct the one given in the header, keep parsing query result
$password = null;
$algorithm = null;
}
}
}
$stmt->close();
$db->close();
if (is_null($password)) {
lime_access_log (LogLevel::DEBUG, "Unable to find password for User: " . $username . " in format " . $requested_algorithm );
return false;
}
//select right hash
switch ($requested_algorithm) {
case 'MD5':
$hash_algo = 'md5';
break;
case 'SHA-256':
$hash_algo = 'sha256';
break;
default:
lime_access_log(LogLevel::WARNING, "Unsupported algo " . $requested_algorithm . " for User:" . $username ."\n");
break;
}
if ($algorithm == 'CLRTXT') {
$A1 = hash($hash_algo, $username.':'.$data['realm'].':'.$password);
} else {
$A1 = $password;
}
}
$A2 = hash($hash_algo, getenv('REQUEST_METHOD').':'.$data['uri']);
$valid_response = hash($hash_algo, $A1.':'.$data['nonce'].':'.$data['nc'].':'.$data['cnonce'].':'.$data['qop'].':'.$A2);
// Compare with the client response
if(hash_equals($valid_response, $data['response'])) {
return $username;
} else {
return false;
}
}
function lime_auth_and_process_request() {
if (array_key_exists('HTTP_X_LIME_USER_IDENTITY', $_SERVER)) {
$from = $_SERVER['HTTP_X_LIME_USER_IDENTITY'];
} else { // legacy: lime user Id(shall be the GRUU) was set in the From Http header
if (array_key_exists('HTTP_FROM', $_SERVER)) {
$from = $_SERVER['HTTP_FROM'];
} else {
$from = null;
}
}
if (defined('CLIENT_CERT_AUTH') && CLIENT_CERT_AUTH === true) {
if (array_key_exists('SSL_CLIENT_VERIFY', $_SERVER) && ($_SERVER['SSL_CLIENT_VERIFY'] == 'SUCCESS')) {
/* get all entries Subject altName DNS: it shall hold the user sip:uri */
$usernames = array();
$i=0;
$SAN_DNS= "SSL_CLIENT_SAN_DNS_0";
while (array_key_exists($SAN_DNS, $_SERVER)) {
if ($_SERVER[$SAN_DNS] !== '') {
array_push($usernames, $_SERVER[$SAN_DNS]);
lime_access_log(LogLevel::DEBUG, "Receive a valid client certificate SAN DNS is ".$_SERVER[$SAN_DNS]);
}
// check next record
$i++;
$SAN_DNS = sprintf("SSL_CLIENT_SAN_DNS_%d", $i);
}
/* Compatibility with certificates using CN - shall be deprecated, use altNames DNS instead */
/* add the subject CN is our list of names */
if (array_key_exists('SSL_CLIENT_S_DN_CN', $_SERVER) && $_SERVER['SSL_CLIENT_S_DN_CN'] !== '') {
array_push($usernames, $_SERVER['SSL_CLIENT_S_DN_CN']);
lime_access_log(LogLevel::DEBUG, "Receive a valid client certificate CN is ".$_SERVER['SSL_CLIENT_S_DN_CN']);
}
// Check that the userId given by HTTP header (shall be the GRUU) match the username and domain given by the certificate
// auth username may contain chars we must escape to turn it into a GRUU compatible(URL like) format
foreach ($usernames as $authenticated_username) {
$pattern = $authenticated_username.';gr=';
if (strpos($from, $pattern) === 0) {
lime_process_request($from, $pattern);
lime_log(LogLevel::ERROR, "Internal Error: something went wrong, execution path gets out of lime_process_request back to client cert auth code");
exit(); // we shall never reach this point, but just in case, if so exit
} else { // it can be an allowed foreign domain
if (defined('FOREIGN_DOMAINS_USERNAME') && is_array(FOREIGN_DOMAINS_USERNAME) && count(FOREIGN_DOMAINS_USERNAME)>0) {
if ($from === $authenticated_username) { // This userId is safe to use, it matches a subject altname or a CN
foreach (FOREIGN_DOMAINS_USERNAME as $allowed_username => $hash) { // do we have it in our white list
if ($allowed_username === $from) {
lime_process_request($from, '', TRUE); // The optional third parameter set to TRUE limit the available request to getPeerBundle
lime_log(LogLevel::ERROR, "Internal Error: something went wrong, execution path gets out of lime_process_request back to client cert auth code");
exit(); // we shall never reach this point, but just in case, if so exit
}
}
}
}
}
}
// GRUU and authenticated user are not matching
lime_access_log(LogLevel::DEBUG, "A User is trying to impersonate another Lime user: passed the client certificate based authentication but provides unmatching ".$from." to Lime as username. Certificate usernames are: ".print_r($usernames ,true));
http_response_code(403);
exit();
}
}
if (!defined("DIGEST_AUTH") || DIGEST_AUTH === true) { // DIGEST_AUTH must be enabled by default on older configuration files
// Check the nonce key value, it's cannot be left empty and must be at least 12 characters
if (!defined("AUTH_NONCE_KEY") || strlen(AUTH_NONCE_KEY) < 12) {
http_response_code(500);
lime_log(LogLevel::ERROR, "Your lime server is badly configured, please set a random string in AUTH_NONCE_KEY at least 12 characters long");
exit();
}
// Check if a friend foreign domain is trying to log in
$foreign_username = null;
$foreign_password_hash = null;
if (defined('FOREIGN_DOMAINS_USERNAME') && is_array(FOREIGN_DOMAINS_USERNAME) && count(FOREIGN_DOMAINS_USERNAME)>0) {
foreach (FOREIGN_DOMAINS_USERNAME as $allowed_username => $hash) { // do we have it in our white list
if ($allowed_username === $from) {
$foreign_username = $from;
$foreign_password_hash = $hash;
lime_access_log(LogLevel::DEBUG, "Lime server from domain ".$foreign_username." is authenticating using digest auth");
// When a foreign domain logs in, its username is its own domain, perform the digest auth using local auth realm as realm
// so it must be defined in the config file
if (!defined("AUTH_REALM")) {
http_response_code(500);
lime_log(LogLevel::ERROR, "Your lime server is badly configured: if a foreign domain server is allowed to log in using digest auth, you must specify your auth realm");
exit();
}
$auth_realm = AUTH_REALM;
}
}
}
if (!isset($foreign_username)) {
// From is the GRUU('sip:username@domain;gr=*;), we need to extract the username and domain from it:
// from position 4(skip 'sip:') until the first occurence of @
// pass it through rawurldecode has GRUU may contain escaped characters
$username = rawurldecode(substr($from,4,strpos($from, '@')-4));
$domain = rawurldecode(substr($from, strpos($from, '@')+1, strpos($from, ';') - strpos($from, '@') - 1 ));
if (!defined("AUTH_REALM")) {
$auth_realm = $domain; // If no auth realm is specified in config, use the domain as auth realm
} else {
$auth_realm = AUTH_REALM;
// default behavior is to have matching domain and auth realm, setting the DOMAIN_AS_AUTH_REALM to False allow to have auth_realm and domain not matching
if(!defined("DOMAIN_AS_AUTH_REALM") || DOMAIN_AS_AUTH_REALM !== False) {
if ($auth_realm !== $domain) {
lime_access_log(LogLevel::DEBUG, "User ".$username." uses forbidden domain ".$domain." IP ".$_SERVER['REMOTE_ADDR']);
http_response_code(403);
exit();
}
}
}
} else {
$username = $foreign_username;
$domain = null;
}
// Get authentication header if there is one
if (array_key_exists('PHP_AUTH_DIGEST', $_SERVER) && !empty($_SERVER['PHP_AUTH_DIGEST'])) {
$authorization = $_SERVER['PHP_AUTH_DIGEST'];
}
// Authentication
if (!empty($authorization)) {
lime_access_log(LogLevel::DEBUG, "There is a digest authentication header for " . $from ." (username ".$username." on domain ".$domain." requesting Auth on realm ".$auth_realm." )\nAuthorization = ". $authorization);
$authenticated_username = authenticate($authorization, $auth_realm, $domain, $foreign_username, $foreign_password_hash);
if ($authenticated_username !== false) {
lime_access_log(LogLevel::DEBUG, "Authentication successful for " . $from ."with username ".$username." and domain ".$domain." on realm ".$auth_realm);
} else {
lime_access_log(LogLevel::DEBUG, "Authentication failed for " . $from . " requesting authorization for user ".$username." on realm ".$auth_realm);
request_authentication($auth_realm, $username, $domain, $foreign_username);
}
} else {
lime_access_log(LogLevel::DEBUG, "There is no authentication digest header for " . $from . " requesting authorization for user ".$username." on realm ".$auth_realm);
request_authentication($auth_realm, $username, $domain, $foreign_username);
}
if (isset($foreign_username)) { // We authenticated using a foreign server username, process the request without further verification
// the last param limit the available requests to get key bundles, the second one is used to limit the request number per users which is not applicable to a foreign server request
lime_process_request($foreign_username, '', TRUE);
lime_log(LogLevel::ERROR, "Internal Error: something went wrong, execution path gets out of lime_process_request back to client cert auth code");
exit();
}
// Check that the userId given by HTTP header (shall be the GRUU) match the username and domain used in authentication
// userId MUST be "sip:<auth username>@<domain>;gr=<...>
// auth username may contain chars we must escape to turn it into a GRUU compatible(URL like) format
$pattern = 'sip:'.username_escape($authenticated_username).'@'.$domain.';gr=';
if (strpos($from, $pattern) === 0) {
lime_process_request($from, $pattern);
lime_log(LogLevel::ERROR, "Internal Error: something went wrong, execution path gets out of lime_process_request back to client cert auth code");
exit();
} else { // GRUU and authenticated user are not matching! Someone is trying to be nasty
lime_access_log(LogLevel::WARNING, "User ".$authenticated_username." (".username_escape($authenticated_username).") is trying to impersonate another Lime user: passed the flexisip based authentication but provides unmatching ".$from." to Lime as username.");
http_response_code(403);
exit();
}
}
}
?>

179
src/lime-createBase.php Normal file
View file

@ -0,0 +1,179 @@
<?php
/*
lime-createBase.php
@copyright Copyright (C) 2018-2024 Belledonne Communications SARL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// This one must be included first as it defines classes
// used in the configuration file
include "lime.php";
// Get the option passed by command line, this is mostly to ensure this script can be run only from CLI
$longopts = array (
"curve:",
"config_path:",
);
$options = getopt("",$longopts);
// get configuration file path, default is /etc/lime-server/lime-server.conf
$config_file= "/etc/lime-server/lime-server.conf";
if (isset($options["config_path"])) {
$config_file=$options["config_path"];
}
include $config_file;
lime_log(LogLevel::DEBUG, "Configuration file path: ".$config_file);
// Convert the command line curve argument
if ($options["curve"] == "C25519") {
$commandCurveId = CurveId::CURVE25519;
} else if ($options["curve"] == "C448") {
$commandCurveId = CurveId::CURVE448;
} else if ($options["curve"] == "C25519K512") {
$commandCurveId = CurveId::CURVE25519K512;
} else {
exit("Bad input parameter : mandatory --curve expect C25519, C448 or C25519K512");
}
// Check server setting:
if (defined('curveId')) {
if (defined('curveIds')) {
exit("Lime server is not correctly configured: curveId and curveIds both defined");
}
if (!lime_checkCurveId(curveId)) {
exit("Lime server is not correctly configured: unknown curve Id ".curveId);
}
// Check anyway that the option and config file match
if ($commandCurveId != curveId) {
exit("Command line and configuration file mismatch on curveId");
}
$lime_db_name = LIME_DB_NAME;
} else if (defined('curveIds')) {
foreach (curveIds as $curve => $dbname) {
if (!lime_checkCurveId($curve)) {
exit("Lime server is not correctly configured: unknown curve Id ".$curve);
}
}
if (!array_key_exists($commandCurveId, curveIds)) {
exit("Command line and configuration file mismatch on curveIds");
}
$lime_db_name = curveIds[$commandCurveId];
} else {
exit("Lime server is not correctly configured: neither curveId nor curvesId defined");
}
try {
$db = mysqli_connect(LIME_DB_HOST, LIME_DB_USER, LIME_DB_PASSWORD);
if (!$db) {
error_log ("Error: Unable to connect to MySQL.\nDebugging errno: " . mysqli_connect_errno() . "\nDebugging error: " . mysqli_connect_error() . "\n");
exit("Bad Database access configuration");
}
// Start a transaction : before version 5.6.5, begin_transaction doesn't support READ_WRITE flag
if ($db->server_version < 50605) {
$db->begin_transaction();
} else {
$db->begin_transaction(MYSQLI_TRANS_START_READ_WRITE);
}
// create the base(we shall get an error if the base already existed)
if (!$db->query("CREATE DATABASE IF NOT EXISTS ".$lime_db_name." CHARACTER SET utf8 COLLATE utf8_bin")) {
exit("Cannot create the database ".$lime_db_name." : ".$db->error);
}
// select DB
$db->select_db($lime_db_name);
/* Users table:
* - id as primary key (internal use)
* - a userId(shall be the GRUU) - this one is indexed as it is used in WHERE clause in many queries
* - Ik (Identity key - EDDSA public key)
* - SPk(the current signed pre-key - ECDH public key)
* - SPk_sig(current SPk public key signed with Identity key)
* - SPk_id (id for SPk provided and internally used by client) - 4 bytes unsigned integer
*/
/* One Time PreKey table:
* - an id as primary key (internal use)
* - the Uid of user owning that key
* - the public key (ECDH public key)
* - OPk_id (id for OPk provided and internally used by client) - 4 bytes unsigned integer
*/
/* Bundle Requests regulation table:
* - source: the source UserId of the bundle request
* - target: the target UserId of the bundle request
* - at: timestamp set when the request is served
*/
/* Config table: holds version parameter:
* - Name: the parameter name (version)
* - Value: the parameter value (db version scheme)
*/
if (!$db->query("CREATE TABLE IF NOT EXISTS Users (
Uid INTEGER NOT NULL AUTO_INCREMENT,
UserId TEXT NOT NULL,
Ik BLOB NOT NULL,
SPk BLOB DEFAULT NULL,
SPk_sig BLOB DEFAULT NULL,
SPk_id INTEGER UNSIGNED DEFAULT NULL,
PRIMARY KEY(Uid),
INDEX(UserId(100)));")
|| !$db->query("CREATE TABLE IF NOT EXISTS OPk (
id INTEGER NOT NULL AUTO_INCREMENT,
Uid INTEGER NOT NULL,
OPk BLOB NOT NULL,
OPk_id INTEGER UNSIGNED NOT NULL,
PRIMARY KEY(id),
FOREIGN KEY(Uid) REFERENCES Users(Uid) ON UPDATE CASCADE ON DELETE CASCADE);")
|| !$db->query("CREATE TABLE IF NOT EXISTS Requests (
source TEXT NOT NULL,
target TEXT NOT NULL,
at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);")
|| !$db->query("CREATE TABLE IF NOT EXISTS Config(
Name VARCHAR(20),
Value INTEGER NOT NULL);")
) {
$db->rollback();
exit("Cannot create tables in database ".$lime_db_name." : ".$db->error);
};
if (!$db->query("INSERT INTO Config(Name, Value) VALUES('version', 0x000001)")) { // version of DB scheme MMmmpp
$db->rollback();
exit("Cannot insert configuration in database ".$lime_db_name." : ".$db->error);
}
// Cleaning the Requests table: Default is to delete any logged requested more than 2 weeks old and to it once a week
if (!$db->query("CREATE EVENT clean_requests ON SCHEDULE EVERY 1 WEEK DO DELETE FROM Requests WHERE at < DATE_SUB(NOW(), INTERVAL 2 WEEK);")) {
$db->rollback();
exit("Cannot insert configuration in database ".$lime_db_name." : ".$db->error);
}
$db->commit();
$db->close();
} catch (Exception $e){
exit("Something went wrong during table creation : ".$e->getMessage());
}
?>

155
src/lime-server.conf Normal file
View file

@ -0,0 +1,155 @@
<?php
/*
lime-server.conf
@copyright Copyright (C) 2018-2024 Belledonne Communications SARL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/* ### Global configuration ### */
// Curve(s) to use, shall be either CurveId::CURVE25519, CurveId::CURVE448 or CURVE25519K512
// to allow only one base algorithm on the server, you can use the curveId and LIME_DB_NAME defines as a shortcut or legacy mode
//define ("curveId", CurveId::CURVE25519);
//define("LIME_DB_NAME", "");
// to allow several base algorithm to be served, define an array of served base algorithms pointing to their respective database name
// this array can hold only one entry
define ("curveIds", array(CurveId::CURVE25519K512 =>"InsertHereTheDatabaseName", CurveId::CURVE25519=>"InsertHereTheDatabaseName"));
// Flexisip database access for authentication
define("AUTH_DB_HOST", "");
define("AUTH_DB_USER", "");
define("AUTH_DB_PASSWORD", "");
define("AUTH_DB_NAME", "");
define("ACCOUNTS_DB_TABLE", "accounts");
define("ACCOUNTS_ALGO_DB_TABLE", "passwords");
define("USE_PERSISTENT_CONNECTIONS", False);
// Lime database access
// this database must already exists with the requested tables
define("LIME_DB_HOST", "");
define("LIME_DB_USER", "");
define("LIME_DB_PASSWORD", "");
/* ### Resource abuse protection ###*/
// Setting to 0 disable the functions
//// Limit the number of OPk or Devices a user can publish on the server
// Warning, this function assumes that device are identified by their GRUU
define("LIME_MAX_DEVICE_PER_USER", 0);
// Do not set this value too low, it shall not be lower than the server_low_limit+batch_size used by client (default on client is 100+25)
define("LIME_MAX_OPK_PER_DEVICE", 0);
//// Limit the number of key bundles a device can request from an other device
//// If you do not need this feature, disable it (comment or set values to 0)
// WARNING: if you enable this request you must have a Requests table in your database. It is highly recommended to use mysql events to clean it.
// See the SQL code in the README for an example. Typical values are to run the event once a week and delete all logs older than 2 weeks
// WARNING: if you enable this feature and the external domain support, please read the WARNING above the later to understand what you're doing
// Maximum number of OPk served to a device from an other one. Typical value: 5
define("LIME_MAX_BUNDLE_REQUEST_NB", 0);
// Period of time (in seconds) on which the maximum applies. Typical value: 7*24*3600 (one week)
define("LIME_MAX_BUNDLE_REQUEST_TIME", 0);
// When maximum bundle served is reached, shall we ignore the request(false) or serve it without OPk(true). Typical value: true
// WARNING: This setting is not effective for cross domain bundle request. In that case: the request will NOT be served when the limit is reached.
define("LIME_MAX_BUNDLE_REQUEST_ALWAYS_SERVE", true);
/* ### Logs configuration ### */
// Time zone configuration
// see https://www.php.net/manual/en/timezones.php for a list of supported timezone
// This setting shall be done in your php.ini, if you cannot modify it, uncomment the following line and use a correct timezone
//date_default_timezone_set('UTC');
// log level one of (LogLevel::DISABLED, ERROR, WARNING, MESSAGE, DEBUG)
// default to DISABLED (recommended value)
define ("lime_logLevel" , LogLevel::DISABLED);
define ("lime_logFile", "/var/opt/belledonne-communications/log/lime-server/lime.log"); // make sure to have actual write permission to this file
define ("lime_accessLogFile", "/var/opt/belledonne-communications/log/lime-server/access-lime.log"); // make sure to have actual write permission to this file
define ("lime_logDomain", "LIME"); // in case Logs are mixed with other applications ones, format is [time tag] -Domain- message
// mysqli-db logs
define("LOGS_ENABLED", False);
// mysqli-db log file
define("LOG_FILE", "/var/opt/belledonne-communications/log/lime-server/lime-db.log");
/* ### Authentication configuration ### */
// Allow client certificate authentication
define("CLIENT_CERT_AUTH", true);
// Allow user db authentication
// explicitely define this constant to false is the only way to disable the digest auth
// if this constant is not defined, digest auth is enabled by default
define("DIGEST_AUTH", true);
// Authentication realm
// If this is not defined, the realm is fetched from the request. Do it ONLY if you need to run several domain/realms on one lime server.
// Otherwise this should be defined to your domain.
define("AUTH_REALM", "sip.example.org");
// If the AUTH_REALM is defined, the default configuration of this switch (not defined or defined to 'True') is to have the users domain (their address is sip:username@domain)
// matching the auth realm. This switch, only when defined to 'False', allows to have several domains using one auth realm.
// WARNING:
// - use with care, do not set to 'False' without a good reason : having multiples sip domain but one auth realm domain on your user authentication server
// - if this switch is set to 'False' make sure your "AUTH_QUERY" includes the domain when selecting the user.
// lime-server version <1.0.26 assumed the user auth worked with only one domain/auth realm, so if you updated from an old version, make sure to update your AUTH_QUERY
// end of the WARNING
define("DOMAIN_AS_AUTH_REALM", True);
// Authentication SQL query
// this SQL query must retrieve a field password and a field algorithm and will bind a string holding the username and the domain into the ?, it shall extract several stored password if we store them in cleartext, MD5 or SHA-256 hash
define("AUTH_QUERY", "SELECT password, algorithm FROM ". ACCOUNTS_ALGO_DB_TABLE . " WHERE account_id=(SELECT id from " . ACCOUNTS_DB_TABLE ." WHERE username=? AND domain=? LIMIT 1);");
// This value must be a random string(12 characters minimum length) specific to each server and is private
define("AUTH_NONCE_KEY", "");
// The authentication is aimed to provide a one time usage nonce, it is not strictly inforced by storing valid once, instead
// we use a short living period, the maximum validity period will be twice the minimum one, value is in seconds
define("MIN_NONCE_VALIDITY_PERIOD", 10);
/* ### Foreign domain ### */
// Define everything needed to communicate with foreign domains:
// The domain name => the url to connect to
// [path to the associated client certificate used to log in]
// [sha256 hashed password: sha256(username:realm:password) default username is the auth_realm on the local server(defined in AUTH_REALM) auth realm is the one used by the foreign server, could be its domain name or not]. You do not really need to know the password, just make sure the hash here is also present in the foreign server in the FOREIGN_DOMAIN_USERNAME array.
// [foreign username: if you do not want to use the local AUTH_REALM as username to authenticate yourself to the foreign server, set it here. Can be useful for Client cert auth if you cannot provide a certificate with SAN including your auth realm]
//
// WARNING: if you enable this feature and the key bundle request limitation you must understand that:
// - Cross domain requests are not subject to limitation as the final server does not limit request from external authorized server
// - Server getting the initial request is responsible to limit the requests towards external domain and will not serve them at all
// if they reach the limit (regardless the setting allow to serve it without OPk)
// Example: client1@domainA requests bundle for client2@domainB
// - if serverA does no enable the request limitation but serverB does, the limitation is not effective on this particular request,
// serverB limitation applies to the requests it receives from clients only, not from other servers
// - if serverA enables the request limitation and the request towards domainB reaches the maximum, the bundle request is not forwarded to
// serverB even if LIME_MAX_BUNDLE_REQUEST_ALWAYS_SERVE is set to true.
//
// end of the WARNING
//
//define("FOREIGN_DOMAINS", array(
// "sip.example2.org" => array("https://lime.example2.org:8543/lime-server/lime-server.php", "/etc/lime-server/certificates/foreign-domain/sip.example2.org.pem", "a31fe9656fc8d3a459e623dc8204e6d0268f8df56d734dac3ca3262edb5db883"),
// "sip.example3.org" => array("https://lime.example3.org:8543/lime-server/lime-server.php", "/etc/lime-server/certificates/foreign-domain/sip.example3.org.pem", "fc638e203db21ffc867d5b9f269b91dcab5bea2a256d7c3cb23cbfc49af5f3ac")
//));
// Define the cafile used to authenticate foreign domain servers certificate
//define("FOREIGN_DOMAINS_CAFILE", "/etc/lime-server/certificates/cafile.pem");
// A list of foreign domains we accept to answer a key bundle request
// it could match the foreign domain list or not
// any domain not listed in this array would not be able to request a key bundle from us
// their identity is checked by either(or both)
// - a TLS client certificate, enable this at web server setting level they must use a client certicate holding their username in subject alt name
// - a http digest auth using sha256 hash: the hash sha256(username:domain:password) is stored in this associative array with username the foreign domain name, realm the local AUTH_REALM
//define("FOREIGN_DOMAINS_USERNAME", array(
// "sip.example2.org" => null, // sip.example2.org lime server cannot identify using digest auth, so tls client auth must be enable for this domain
// "sip.example4.org" => "9c9c6b7e5d31fccf073df5d0d6374e4af4a9fe52b0c63c94d278f188419e8946" // sip.example4.org lime server can identify using digest auth, this hash is sha-256(sip.example4.org:AUTH_REALM:password). You do not need to know the actual password, the same hash must be inserted in the FOREIGN_DOMAINS array on the sip.example4.org lime server configuration file
//));
?>

40
src/lime-server.php Normal file
View file

@ -0,0 +1,40 @@
<?php
/*
lime-server.php
@copyright Copyright (C) 2018-2024 Belledonne Communications SARL
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// avoid date() warnings
// time zone shall be set in php.ini or in lime-server.conf if needed
date_default_timezone_set(@date_default_timezone_get());
// This one must be included first as it defines classes
// used in the configuration file
include "authenticated_lime.php";
// get configuration file path, default is /etc/lime-server/lime-server.conf
$config_file= "/etc/lime-server/lime-server.conf";
if (isset($_SERVER["lime_config_path"])) {
$config_file=$_SERVER["lime_config_path"];
}
include $config_file;
lime_log(LogLevel::DEBUG, "Configuration file path: ".$config_file);
lime_auth_and_process_request();
?>

1181
src/lime.php Normal file
View file

File diff suppressed because it is too large Load diff