From 6149cb8df800b549ed54702370edfacd6ee505ba Mon Sep 17 00:00:00 2001 From: James Rosewell Date: Tue, 3 Nov 2026 18:44:10 +0000 Subject: [PATCH 1/3] Check that only rc merges into the default branch (#41) --- .github/workflows/only-rc-into-main.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/workflows/only-rc-into-main.yml diff --git a/.github/workflows/only-rc-into-main.yml b/.github/workflows/only-rc-into-main.yml new file mode 100644 index 0000000..69e19ca --- /dev/null +++ b/.github/workflows/only-rc-into-main.yml @@ -0,0 +1,11 @@ +name: Only rc into main + +# A pull request into the default branch must come from rc. See +# 51Degrees/common-ci .github/workflows/only-rc-into-main.yml. +on: + pull_request: + +jobs: + rc: + name: Only rc into main + uses: 51Degrees/common-ci/.github/workflows/only-rc-into-main.yml@main From f79100456bfd44e76129b2ab780c1d5c672656af Mon Sep 17 00:00:00 2001 From: James Rosewell Date: Wed, 11 Nov 2026 23:49:41 +0000 Subject: [PATCH 2/3] Add the licence as LICENSE, in the form 51degrees-cxx uses (#44) * Add the licence as LICENSE and NOTICE, in the form 51degrees-cxx uses The repository had no licence file. LICENSE is the plain EUPL v1.2 text, byte for byte the file in 51degrees-cxx and data, and NOTICE holds the two additional terms that every 51Degrees source header repeats. * Keep the licence in LICENSE alone, with no NOTICE The two additional terms are stated in the header of every source file, which is where they apply, so NOTICE is removed, as in 51degrees-cxx. --- LICENSE | 274 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 274 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a74f044 --- /dev/null +++ b/LICENSE @@ -0,0 +1,274 @@ +European Union Public Licence +V. 1.2 + +EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as +defined below) which is provided under the terms of this Licence. Any use of +the Work, other than as authorised under this Licence is prohibited (to the +extent such use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: “Licensed under the EUPL”, or has expressed by +any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: +— ‘The Licence’: this Licence. +— ‘The Original Work’: the work or software distributed or communicated by the + ‘Licensor under this Licence, available as Source Code and also as + ‘Executable Code as the case may be. +— ‘Derivative Works’: the works or software that could be created by the + ‘Licensee, based upon the Original Work or modifications thereof. This + ‘Licence does not define the extent of modification or dependence on the + ‘Original Work required in order to classify a work as a Derivative Work; + ‘this extent is determined by copyright law applicable in the country + ‘mentioned in Article 15. +— ‘The Work’: the Original Work or its Derivative Works. +— ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +— ‘The Executable Code’: any code which has generally been compiled and which + is meant to be interpreted by a computer as a program. +— ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. +— ‘Contributor(s)’: any natural or legal person who modifies the Work under + the Licence, or otherwise contributes to the creation of a Derivative Work. +— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. +— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright +vested in the Original Work: + +— use the Work in any circumstance and for all usage, +— reproduce the Work, +— modify the Work, and make Derivative Works based upon the Work, +— communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case + may be, the Work, +— distribute the Work or copies thereof, +— lend and rent the Work or copies thereof, +— sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make +effective the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights +to any patents held by the Licensor, to the extent necessary to make use of +the rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, +in a notice following the copyright notice attached to the Work, a repository +where the Source Code is easily and freely accessible for as long as the +Licensor continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits +from any exception or limitation to the exclusive rights of the rights owners +in the Work, of the exhaustion of those rights or of other applicable +limitations thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and +a copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of +the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions +on the Work or Derivative Work that alter or restrict the terms of the +Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed +under a Compatible Licence, this Distribution or Communication can be done +under the terms of this Compatible Licence. For the sake of this clause, +‘Compatible Licence’ refers to the licences listed in the appendix attached to +this Licence. Should the Licensee's obligations under the Compatible Licence +conflict with his/her obligations under this Licence, the obligations of the +Compatible Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code or +indicate a repository where this Source will be easily and freely available +for as long as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade +names, trademarks, service marks, or names of the Licensor, except as required +for reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she +brings to the Work are owned by him/her or licensed to him/her and that he/she +has the power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ +basis and without warranties of any kind concerning the Work, including +without limitation merchantability, fitness for a particular purpose, absence +of defects or errors, accuracy, non-infringement of intellectual property +rights other than copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a +condition for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the +use of the Work, including without limitation, damages for loss of goodwill, +work stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such +damage. However, the Licensor will be liable under statutory product liability +laws as far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional +agreement, defining obligations or services consistent with this Licence. +However, if accepting obligations, You may act only on your own behalf and on +your sole responsibility, not on behalf of the original Licensor or any other +Contributor, and only if You agree to indemnify, defend, and hold each +Contributor harmless for any liability incurred by, or claims asserted against +such Contributor by the fact You have accepted any warranty or additional +liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I +agree’ placed under the bottom of a window displaying the text of this Licence +or by affirming consent in any other similar way, in accordance with the rules +of applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this +Licence, such as the use of the Work, the creation by You of a Derivative Work +or the Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of +electronic communication by You (for example, by offering to download the Work +from a remote location) the distribution channel or media (for example, a +website) must at least provide to the public the information requested by the +applicable law regarding the Licensor, the Licence and the way it may be +accessible, concluded, stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. Such a termination +will not terminate the licences of any person who has received the Work from +the Licensee under the Licence, provided such persons remain in full +compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions +of this Licence or updated versions of the Appendix, so far this is required +and reasonable, without reducing the scope of the rights granted by the +Licence. New versions of the Licence will be published with a unique version +number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, +— any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty + on the Functioning of the European Union, +— any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive + jurisdiction of the competent court where the Licensor resides or conducts + its primary business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, +— this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, +— this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: +— GNU General Public License (GPL) v. 2, v. 3 +— GNU Affero General Public License (AGPL) v. 3 +— Open Software License (OSL) v. 2.1, v. 3.0 +— Eclipse Public License (EPL) v. 1.0 +— CeCILL v. 2.0, v. 2.1 +— Mozilla Public Licence (MPL) v. 2 +— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +— European Union Public Licence (EUPL) v. 1.1, v. 1.2 +— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or + Strong Reciprocity (LiLiQ-R+) + +— The European Commission may update this Appendix to later versions of the + above licences without producing a new version of the EUPL, as long as they + provide the rights granted in Article 2 of this Licence and protect the + covered Source Code from exclusive appropriation. +— All other changes or additions to this Appendix require the production of a + new EUPL version. From 4009c261c8f9b74f78016d58157e86764eba510c Mon Sep 17 00:00:00 2001 From: James Rosewell Date: Thu, 12 Nov 2026 19:17:19 +0000 Subject: [PATCH 3/3] Replace the README with a notice that the repository is archived (#46) The files and scripts are now in the data repository. The notice says where they went, how to get the free data files from there, and which repositories now hold the examples and APIs that used them. --- README.md | 140 ++++++++++-------------------------------------------- 1 file changed, 26 insertions(+), 114 deletions(-) diff --git a/README.md b/README.md index 83e4087..95e7f71 100644 --- a/README.md +++ b/README.md @@ -1,123 +1,35 @@ -# ![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=ip-intelligence-data-files "Data rewards the curious") **IP Intelligence Data Files** +# IP Intelligence data files (archived) -## Introduction +This repository is archived and kept read-only. Its Asn data file, evidence +files, country codes, country name translations, scripts and tests are now in +the `ip-intelligence` folder of the [data](https://github.com/51Degrees/data) +repository. -This repo allows to obtain data needed to run IP Intelligence examples: -- evidence files with lists of random IP addresses needed for some examples -- scripts to generate lists of random IP addresses like the above -- scripts to download 'Lite' IP Intelligence data file -- translation files to support translation engine and examples +## Get the free data files -## Download Lite data file +The data repository lists each free data file as a link, and a script +downloads the files into place. No License Key is needed. To clone the +repository and download every free file in one command, run this. -The Lite data file is too large to commit to this repository, so one of the -scripts below downloads it from 51Degrees storage instead: - -| Script | Language | OS | -| -- | -- | -- | -| `./get-lite-file-from-azure.ps1` | PowerShell | [Windows](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5), [Linux](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux?view=powershell-7.5), [macOS](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos?view=powershell-7.5) | -| `./get-lite-file-from-azure.sh` | Shell | Linux, macOS | - -Run the script from this directory, because the examples and tests look for -the file here: - -```pwsh -cd ip-intelligence-data -./get-lite-file-from-azure.ps1 -``` - -The script downloads the archive as `51Degrees-LiteV41.ipi.gz` (about 230 MB), -prints its MD5 hash and unpacks it to `51Degrees-LiteV41.ipi` (about 460 MB) -in the directory it is run from. If the archive is already present the -download is skipped and the existing archive is unpacked again. Pass `-Force` -(PowerShell) or `-f` (shell) to download a fresh copy, for example when a new -monthly data file has been published. The shell script needs `curl`, `gunzip` -and `md5sum` (`md5` on macOS) to be available. - - -## Files - -### `51Degrees-IPIV4AsnIpiV41.ipi` - -The on-premise IP Intelligence data file for Asn properties. - -The [properties](https://51degrees.me/developers/property-dictionary?item=Asn%7CAll) available in this file are: - -- Asn -- AsnName - -More properties are available as part of the Enterprise data file - [contact us](https://51degrees.com/contact-us?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=51degrees-ipiv4asnipiv41-ipi). - -This file is updated monthly. - -### `51Degrees-LiteV41.ipi` - -The 'lite' on-premise IP Intelligence data file. - -The properties available in this file are: - -- RegisteredCountry -- RegisteredName -- RegisteredOwner - -More properties are available as part of the Enterprise data file - [contact us](https://51degrees.com/contact-us?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=51degrees-litev41-ipi). - -This 'lite' file is built from a subsection of all IPs and is updated less frequently than the Enterprise IPI data file. - -### `get-lite-file-from-azure.ps1`/`.sh` - -Convenience scripts to download (and unpack) data file, stored on Azure Blob Storage. - -### `evidence-gen.ps1` - -A script to re-/generate the "evidence" files (CSV/YML) with a designated number of random IPv4 and/or IPv6 addresses. - -Useful invocations: - -```pwsh - ./evidence-gen.ps1 -v4 10000 -v6 10000 "evidence.yml" - ./evidence-gen.ps1 -v4 10000 -v6 10000 -csv "evidence.csv" -``` - -### `evidence.csv`/`.yml` - -Pre-generated test files containing 20,000 of random IPs. - -- evidence.csv - Each line contains a single IP. -- evidence.yml - A multi-record yaml file where each line contains the HTTP header name and value as the key/value pair. Values may be wrapped in single quotes. - -## Tests - -The download scripts are covered by a Pester 5 test suite: - -| File | Role | -| -- | -- | -| `ci/run-unit-tests.ps1` | Entry point. Installs Pester if needed, runs the suite, and writes a NUnit XML report to `test-results/`. | -| `tests/check-dl-script.tests.ps1` | Pester test suite with 8 test cases (4 per download script). | - -Run all tests (requires [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell)): - -```pwsh -cd ip-intelligence-data -./ci/run-unit-tests.ps1 +```sh +git clone https://github.com/51Degrees/data.git && data/get-data-files.sh ``` -Each test performs a **real download** from 51Degrees storage into an isolated -temporary directory and verifies the archive is fetched, its printed MD5 -matches a re-computed hash, and the file unpacks correctly. The test cases are: - -- `Downloads both files (no args)` - no flags (both Lite + Asn files) -- `Downloads Lite only (-Lite)` - only the Lite file -- `Downloads Asn only (-Asn)` - only the Asn file -- `Forces re-download (-Force)` - pre-seeds dummy files then passes `-Force` to verify they are overwritten - -## Translation +In PowerShell, run `./get-data-files.ps1` in the `data` folder instead. The +[data README](https://github.com/51Degrees/data#get-the-data-files) says how +to download only some files, or the newer versions of files you already have. -Folder containing yaml files for translation of country names into several target languages. This data is used in examples and by the translation engine. +## Examples and APIs -### Folder structure -|--Translations -| |--Translation Source (e.g. "OSM") -| | |-- Translation File (e.g. "countries.fr_FR.yml") +The examples and APIs that used these files are now in these repositories. -Each translation file contains key-value pairs of "English country name: country name in target language". +- [C and C++](https://github.com/51Degrees/51degrees-cxx) +- [.NET](https://github.com/51Degrees/51degrees-dotnet) +- [Go](https://github.com/51Degrees/51degrees-go) +- [Java](https://github.com/51Degrees/51degrees-java) +- [Nginx](https://github.com/51Degrees/51degrees-nginx) +- [Node.js](https://github.com/51Degrees/51degrees-node) +- [PHP](https://github.com/51Degrees/51degrees-php) +- [Python](https://github.com/51Degrees/51degrees-python) +- [Rust](https://github.com/51Degrees/51degrees-rust) +- [Varnish](https://github.com/51Degrees/51degrees-varnish)