Skip to content

Class: Location

The Geo Location object describes a geographical location, usually associated

with an IP address.

URI: ocsf:Location

 classDiagram
    class Location
    click Location href "../Location/"
      Object <|-- Location
        click Object href "../Object/"


      Location <|-- UnmannedSystemOperatingArea
        click UnmannedSystemOperatingArea href "../UnmannedSystemOperatingArea/"


      Location : aerial_height

      Location : city

      Location : continent

      Location : coordinates

      Location : country

      Location : desc

      Location : geodetic_altitude

      Location : geodetic_vertical_accuracy

      Location : geohash

      Location : horizontal_accuracy

      Location : is_on_premises

      Location : isp

      Location : lat

      Location : long

      Location : postal_code

      Location : pressure_altitude

      Location : provider

      Location : region

Inheritance

Slots

Name Cardinality and Range Description Inheritance
aerial_height 0..1
String
Expressed as either height above takeoff location or height above ground leve... direct
city 0..1 recommended
String
The name of the city direct
continent 0..1 recommended
String
The name of the continent direct
coordinates *
Float
A two-element array, containing a longitude/latitude pair direct
country 0..1 recommended
String
The ISO 3166-1 Alpha-2 country code direct
desc 0..1
String
The description of the geographical location direct
geodetic_altitude 0..1
String
The aircraft distance above or below the ellipsoid as measured along a line direct
geodetic_vertical_accuracy 0..1
String
Provides quality/containment on geodetic altitude direct
geohash 0..1
String

Geohash of the geo-coordinates (latitude and longitude)

direct
horizontal_accuracy 0..1
String
Provides quality/containment on horizontal position direct
is_on_premises 0..1
Boolean
Indicates whether the location is on-premises direct
isp 0..1
String
The name of the Internet Service Provider (ISP) direct
lat 0..1
Float
The geographical Latitude coordinate represented in Decimal Degrees (DD) direct
long 0..1
Float
The geographical Longitude coordinate represented in Decimal Degrees (DD) direct
postal_code 0..1
String
The postal code of the location direct
pressure_altitude 0..1
String
The uncorrected barometric pressure altitude (based on reference standard 29 direct
provider 0..1
String
The provider of the geographical location data direct
region 0..1
String
The alphanumeric code that identifies the principal subdivision (e direct

Usages

used by used in type used
Osint location range Location
Aircraft location range Location
DomainContact location range Location
Endpoint location range Location
LdapPerson location range Location
ManagedEntity location range Location
NetworkEndpoint location range Location
NetworkProxy location range Location
UnmannedAerialSystem location range Location
UnmannedSystemOperatingArea locations range Location
Device location range Location

Rules

Rule Applied Preconditions Postconditions Elseconditions
any_of [{'slot_conditions': {'city': {'required': True}}}, {'slot_conditions': {'country': {'required': True}}}, {'slot_conditions': {'postal_code': {'required': True}}}, {'slot_conditions': {'region': {'required': True}}}]

In Subsets

Aliases

  • Geo Location

Identifier and Mapping Information

Annotations

property value
ocsf_constraints {"at_least_one": ["city", "country", "postal_code", "region"]}
observable_id 26

Schema Source

Mappings

Mapping Type Mapped Value
self ocsf:Location
native ocsf:Location
exact uco_master:Location

LinkML Source

Direct

name: Location
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["city", "country", "postal_code", "region"]}'
  observable_id:
    tag: observable_id
    value: 26
description: 'The Geo Location object describes a geographical location, usually associated

  with an IP address.'
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Geo Location
exact_mappings:
- uco_master:Location
is_a: Object
slots:
- aerial_height
- city
- continent
- coordinates
- country
- desc
- geodetic_altitude
- geodetic_vertical_accuracy
- geohash
- horizontal_accuracy
- is_on_premises
- isp
- lat
- long
- postal_code
- pressure_altitude
- provider
- region
slot_usage:
  city:
    name: city
    recommended: true
  continent:
    name: continent
    recommended: true
  country:
    name: country
    recommended: true
  desc:
    name: desc
    description: The description of the geographical location.
  isp:
    name: isp
    deprecated: 'Utilize <code>isp</code> attribute available in <code>network_endpoint,

      whois</code> objects according to your use-case.'
  provider:
    name: provider
    description: The provider of the geographical location data.
  region:
    name: region
    description: 'The alphanumeric code that identifies the principal subdivision
      (e.g. province

      or state) of the country. For example, ''CH-VD'' for the Canton of Vaud,

      Switzerland'
rules:
- postconditions:
    any_of:
    - slot_conditions:
        city:
          name: city
          required: true
    - slot_conditions:
        country:
          name: country
          required: true
    - slot_conditions:
        postal_code:
          name: postal_code
          required: true
    - slot_conditions:
        region:
          name: region
          required: true
  description: 'OCSF at_least_one: at least one of [''city'', ''country'', ''postal_code'',
    ''region'']

    must be set.'

Induced

name: Location
annotations:
  ocsf_constraints:
    tag: ocsf_constraints
    value: '{"at_least_one": ["city", "country", "postal_code", "region"]}'
  observable_id:
    tag: observable_id
    value: 26
description: 'The Geo Location object describes a geographical location, usually associated

  with an IP address.'
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Geo Location
exact_mappings:
- uco_master:Location
is_a: Object
slot_usage:
  city:
    name: city
    recommended: true
  continent:
    name: continent
    recommended: true
  country:
    name: country
    recommended: true
  desc:
    name: desc
    description: The description of the geographical location.
  isp:
    name: isp
    deprecated: 'Utilize <code>isp</code> attribute available in <code>network_endpoint,

      whois</code> objects according to your use-case.'
  provider:
    name: provider
    description: The provider of the geographical location data.
  region:
    name: region
    description: 'The alphanumeric code that identifies the principal subdivision
      (e.g. province

      or state) of the country. For example, ''CH-VD'' for the Canton of Vaud,

      Switzerland'
attributes:
  aerial_height:
    name: aerial_height
    description: 'Expressed as either height above takeoff location or height above
      ground level

      (AGL) for a UAS current location. This value is provided in meters and must

      have a minimum resolution of 1 m. Special Values: <code>Invalid</code>,

      <code>No Value</code>, or <code>Unknown: -1000 m</code>.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Aerial Height
    rank: 1000
    alias: aerial_height
    owner: Location
    domain_of:
    - Location
    range: string
  city:
    name: city
    description: The name of the city.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - City
    rank: 1000
    alias: city
    owner: Location
    domain_of:
    - Location
    range: string
    recommended: true
  continent:
    name: continent
    description: The name of the continent.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Continent
    rank: 1000
    alias: continent
    owner: Location
    domain_of:
    - Location
    range: string
    recommended: true
  coordinates:
    name: coordinates
    description: 'A two-element array, containing a longitude/latitude pair. The format
      conforms

      with <a target=''_blank'' href=''https://geojson.org''>GeoJSON</a>. For example:

      <code>[-73.983, 40.719]</code>.'
    deprecated: Use specific <code>lat, long</code> attributes instead. (since 1.2.0)
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Coordinates
    rank: 1000
    alias: coordinates
    owner: Location
    domain_of:
    - Location
    range: float
    multivalued: true
  country:
    name: country
    annotations:
      observable_id:
        tag: observable_id
        value: 14
    description: 'The ISO 3166-1 Alpha-2 country code.<p><b>Note:</b> The two letter
      country code

      should be capitalized. For example: <code>US</code> or <code>CA</code>.</p>'
    notes:
    - ISO 3166-1 alpha-2 codes — https://www.iso.org/obp/ui/#iso:pub:PUB500001:en
    from_schema: https://w3id.org/lmodel/ocsf
    see_also:
    - https://www.iso.org/obp/ui/#iso:pub:PUB500001:en
    aliases:
    - Country
    rank: 1000
    alias: country
    owner: Location
    domain_of:
    - Os
    - Location
    range: string
    recommended: true
  desc:
    name: desc
    description: The description of the geographical location.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Description
    rank: 1000
    alias: desc
    owner: Location
    domain_of:
    - Osint
    - RelatedEvent
    - Remediation
    - Vulnerability
    - Advisory
    - Analytic
    - ApplicationObject
    - Assessment
    - Check
    - CisBenchmark
    - CisBenchmarkResult
    - CisControl
    - Compliance
    - Cve
    - Database
    - Databucket
    - Enrichment
    - File
    - FindingObject
    - FindingInfo
    - Graph
    - Group
    - Job
    - Location
    - Node
    - Policy
    - Rule
    - Table
    - WebResource
    - Device
    - IncidentFinding
    range: string
  geodetic_altitude:
    name: geodetic_altitude
    description: 'The aircraft distance above or below the ellipsoid as measured along
      a line

      that passes through the aircraft and is normal to the surface of the WGS-84

      ellipsoid. This value is provided in meters and must have a minimum resolution

      of 1 m. Special Values: <code>Invalid</code>, <code>No Value</code>, or

      <code>Unknown: -1000 m</code>.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Geodetic Altitude
    rank: 1000
    alias: geodetic_altitude
    owner: Location
    domain_of:
    - Location
    range: string
  geodetic_vertical_accuracy:
    name: geodetic_vertical_accuracy
    description: 'Provides quality/containment on geodetic altitude. This is based
      on ADS-B

      Geodetic Vertical Accuracy (GVA). Measured in meters.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Geodetic Vertical Accuracy
    rank: 1000
    alias: geodetic_vertical_accuracy
    owner: Location
    domain_of:
    - Location
    range: string
  geohash:
    name: geohash
    description: '<p>Geohash of the geo-coordinates (latitude and longitude).</p><a

      target=''_blank'' href=''https://en.wikipedia.org/wiki/Geohash''>Geohashing</a>
      is

      a geocoding system used to encode geographic coordinates in decimal degrees,
      to

      a single string.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Geohash
    rank: 1000
    alias: geohash
    owner: Location
    domain_of:
    - Location
    range: string
  horizontal_accuracy:
    name: horizontal_accuracy
    description: 'Provides quality/containment on horizontal position. This is based
      on ADS-B

      NACp. Measured in meters.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Horizontal Accuracy
    rank: 1000
    alias: horizontal_accuracy
    owner: Location
    domain_of:
    - Location
    range: string
  is_on_premises:
    name: is_on_premises
    description: Indicates whether the location is on-premises.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - On-Premises
    rank: 1000
    alias: is_on_premises
    owner: Location
    domain_of:
    - Location
    range: boolean
  isp:
    name: isp
    description: The name of the Internet Service Provider (ISP).
    deprecated: 'Utilize <code>isp</code> attribute available in <code>network_endpoint,

      whois</code> objects according to your use-case.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - ISP Name
    rank: 1000
    alias: isp
    owner: Location
    domain_of:
    - Whois
    - Location
    - NetworkEndpoint
    range: string
  lat:
    name: lat
    description: 'The geographical Latitude coordinate represented in Decimal Degrees
      (DD). For

      example: <code>42.361145</code>.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Latitude
    rank: 1000
    alias: lat
    owner: Location
    domain_of:
    - Location
    range: float
  long:
    name: long
    description: 'The geographical Longitude coordinate represented in Decimal Degrees
      (DD). For

      example: <code>-71.057083</code>.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Longitude
    rank: 1000
    alias: long
    owner: Location
    domain_of:
    - Location
    range: float
  postal_code:
    name: postal_code
    description: The postal code of the location.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Postal Code
    rank: 1000
    alias: postal_code
    owner: Location
    domain_of:
    - Location
    range: string
  pressure_altitude:
    name: pressure_altitude
    description: 'The uncorrected barometric pressure altitude (based on reference
      standard 29.92

      inHg, 1013.25 mb) provides a reference for algorithms that utilize ''altitude

      deltas'' between aircraft. This value is provided in meters and must have a

      minimum resolution of 1 m.. Special Values: <code>Invalid</code>, <code>No

      Value</code>, or <code>Unknown: -1000 m</code>.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Pressure Altitude
    rank: 1000
    alias: pressure_altitude
    owner: Location
    domain_of:
    - Location
    range: string
  provider:
    name: provider
    description: The provider of the geographical location data.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Provider
    rank: 1000
    alias: provider
    owner: Location
    domain_of:
    - Reputation
    - AuthFactor
    - Cloud
    - Enrichment
    - Location
    - Malware
    - ResourceDetails
    range: string
  region:
    name: region
    description: 'The alphanumeric code that identifies the principal subdivision
      (e.g. province

      or state) of the country. For example, ''CH-VD'' for the Canton of Vaud,

      Switzerland'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Region
    rank: 1000
    alias: region
    owner: Location
    domain_of:
    - ApplicationObject
    - Cloud
    - Databucket
    - Location
    - ResourceDetails
    - Device
    - CloudResourcesInventoryInfo
    range: string
rules:
- postconditions:
    any_of:
    - slot_conditions:
        city:
          name: city
          required: true
    - slot_conditions:
        country:
          name: country
          required: true
    - slot_conditions:
        postal_code:
          name: postal_code
          required: true
    - slot_conditions:
        region:
          name: region
          required: true
  description: 'OCSF at_least_one: at least one of [''city'', ''country'', ''postal_code'',
    ''region'']

    must be set.'