App-ID Use Cases, Syntax and AttributesSEC-2015-0508-App-ID_Use_Cases,_Syntax_and_Attributes

Group Name: ArchitectureSource: Darold Hemphill, iconectiv, dhemphill@iconectiv.comMeeting Date: 2015-05

© 2015 oneM2M Partners

Contents

• Overview of App-ID Registry• App-ID Use Cases• App-ID Attributes• App-ID Format• Summary

2

© 2015 oneM2M Partners

Overview of App-ID RegistryATIS supports a simple structure for the App-ID Registry Architecture outlined in AI-2015-0003 and would be willing to serve as the Contracting Authority.

3

While ATIS supports the initial designation of a single CA and RA to expedite the availability of App IDs, it does not oppose the future expansion of these roles to include multiple CAs/RAs.

App Developers

App-ID Registry StakeholdersThe App-ID Registry refers to the overall structure, which includes:

– Contracting Authority (CA), which is the legal entity that will contract with an organization that will issue unique global identifiers.

– Registration Authority (RA), which is the legal entity that manages/administers the App-ID database used to issue unique global identifiers consistent with oneM2M specifications.

– Registrars, which are legal entities that will directly interface with App Developers seeking App-IDs and can assign unique IDs.

– App Developers, which are companies/individuals seeking to obtain a registered App-ID.

Additional details regarding these stakeholders is provided on subsequent slides.

Note: slides 3 and 4 are from “AI-2015-0006-ATIS_Views_on_App-ID_Registry.PPT”, 2015-03-18.

4

App-ID Use Cases

Registry for oneM2M Applications•Provide the App-ID when registering an Application Entity (AE) with a CSERegistry for oneM2M Service Providers•Configure the Common Services Entity with allowed App-IDs i.e., allowedApp-IDs

– Enumerate allowed App-IDs– Wildcards allowed e.g., allow all software versions

for base App-ID5

© 2015 oneM2M Partners

Registry for oneM2M Community•Query by App-ID to discover application name, developer and software version•Query by application name to find App-ID, developer and software versions•Query by application description to discover App-IDs, application names and developers of applicationsRegistry for oneM2M Developers•Register App-IDs for new standalone or embedded application and their versions•Update App-ID attributes to keep the registry information up to date

Network Service Layer

Common Services Layer

oneM2M Solution

App-IDRegistry

Application Layer

App-ID Registry Use Cases

App-ID in TS-0001-V1.4.0

7

7.1.3 Application Identifier (App-ID)There are two types of App-ID: registration authority defined App-ID (registered App-ID) and non-registered App-ID. The establishment of the registered App-ID is guaranteed to be globally unique; the non-registered App-ID is not guaranteed to be globally unique. The detail format is described in clause 7.2 (see table row extracted at bottom of the slide)

11.2.2 M2M Application EnrolmentThis procedure is an optional step that enables the M2M SP and/or M2M application provider to control which applications are allowed to use the M2M services. It assumes that M2M applications obtains or registers credentials to be used for controlling authorization with an M2M application registration authority (see clause 7.1.3). Each application identified by an App-ID is then associated with a security credential (M2M Application key) which can be used to grant specific authorization to access an approved list of M2M services. Such authorization takes place between a CSE and an AE as specified in the present document and the oneM2M security specification [1].

IdentifierName

Absolute &Format-Designator

orRelative &

Format-Designator & Context

Format Rule of use

APP-ID App-ID Either “R[authority-ID]/[registered-App-ID]” or “N[non-registered-App-ID]” If the first letter is “R”, then authority-ID and registered-App-ID are assigned by the registration authority. The registered-App-ID is managed by the owner of authority-ID.If the first letter is “N”, then non-registered-App-ID is not registered by the registration authority.

AE Registration Procedure described in clause 10.1.1.2.2.

App-ID Proposal• Didn’t find any length restriction for App-ID although

generally shorter is better• App-ID is our focus, but we can reuse <appName> as

already defined• It is not necessary to include the [authority-ID] in the

App-ID code with a central registration authority• Either “R[authority-ID]/[registered-App-ID]” or

“N[non-registered-App-ID]” – is there any latitude?

8

© 2015 oneM2M Partners

App-ID Requirements1. Registered App-IDs shall be unique2. All content in the Registry will be in English3. App-ID required fields shall be provided

a) Application Name – name of the oneM2M applicationb) Application Description – short description of the oneM2M applicationc) Application Version – oneM2M application version identifier e.g., 2.2.4d) Responsible Party – name of the responsible party (see next slide)e) Application Status – oneM2M application status: Alpha, Beta, General

Availability, End of Life4. App-ID optional fields may be provided

a) Application Home page – URL of Application to learn moreb) Application Store page – URL where application can be purchased or

downloadedc) Other fields – additional fields at the discretion of the Registration Authority

9

© 2015 oneM2M Partners

Required Attributes for App-ID

Responsible Party Issues1. Responsible Party is the Company, Group or

Individual which registers the application2. Only a representative of the Responsible Party

can create and version an App-ID and update attributes

3. Registry users are associated to a Responsible Party to control management of App-IDs

10

Proposed App-ID Format

SENS-HeatingMonitoring-7[appType]-[appName]-[sequenceNo]

OrSENS-HeatingMonitoring-1-ATT

[appType]-[appName]-[sequenceNo]-[whiteLabel]

Notes: appName is defined in TS-0001 as: The name of the application, as declared by the application developer (e.g., "HeatingMonitoring") p. 114.

11

App-ID Format• appType – short identifier that indicates the primary function

of the application. See next slide on proposed initial values of appTypes

• appName – Application Name with spaces removed e.g., “Smart City Controller, 2.2.4” becomes SmartCityController

• sequenceNo – sequence number of the registered application – corresponds to the version number e.g., v 2.3.1 could be sequenceNo 7

• whiteLabel – optional value used to distinguish applications differentiated only by configuration for a particular customer

12

Example Initial appType Values

13

Function appType DescriptionAnalysis ANLYS Analysis of information

Data Store DATST Amass and manage information repositories of information

Integration INTEG Involved in integrating information from different sources

Processor PROC Sum, tabulate, consolidate larger numbers of inputs into summarized information

Management MGMT Concerned with the oversight and management of other nodes

Monitor MONTR Monitor the function of the oneM2M network

Security SECUR Authorize and authenticate oneM2M communications

Sensor SENSR Report the value of one or more attributes

Non-registered NREG Non-registered App-ID – not available in the centralized App-ID registry. May be available in a private company registry

Summary

• Initial proposal for App-ID attributes and code format – effort is targeted to close by TP 18

• An initial draft of App-ID recommendations is contained in related contribution to TS-0002

• It is understood that additional concepts and issues may arise as the result of this overview

14