Gateway Agent - First Amendment to the High Level Design Document

Transcription

1 Gateway Agent - First Amendment t the High Level Design Dcument Scpe The Gateway Agent HLD thrugh update 1 assumes that nly the Cntrl App, while cnnected t the prximal netwrk, can initiate new clud services. Typically a Cntrl App is installed in an AllJyn device, such as a Smart Phne. Once installed the Cntrl App arranges fr installatin f the apprpriate Cnnectr App in the gateway nde fr its clud service. It als enables the user t create a remte prfile fr which f their AllJyn devices will cnnect t the clud service. This apprach is well matched fr cnsumer/retail prducts where the clud services are initiated with the installatin f a Cntrl App (a mbile app frm a typically dwnladed frm a mbile app stre). Hwever, this services mdel is nt well matched fr managed Services Prviders wh ffer hme autmatin, security, entertainment and similar services that must be remtely and securely prvisined. Additinally, tday s cnnected prducts ften cme with a bundled clud service, placing the prduct s prvider in the rle f a Services Prvider. Fr Services Prviders, it is critical that everything wrk autmatically when the new prduct is plugged in fr the first time. It is als imprtant t mst Services Prviders t be able t limit what changes their custmer can make t their their services gateway r hub, that will run the Gateway Agent. The Services Prvider als needs access and full cntrl f the gateway r hub after installatin, bth t prvide updates and t prvide custmer supprt. T handle this, bth new services and the remte prfile need t be fully manageable by the Services Prvider. The Cnnectr App must als be able t be initially installed, updated and deactivated/remved by the Services Prvider. This First Amendment t the Gateway Agent HLD defines a new remte management mde called Service Prvider Mde. The features, requirements and high level architecture are included in this Amendment. The nn-service Prvider Mde is nw called Cnsumer Mde and remains as defined in the HLD. Service Prvider Mde - Remte Prvisining fr Services Prviders The Service Prvider Mde implements remte prvisining fr clud services fr AllJyn devices via the Gateway Agent management applicatin. The Service Prvider Mde prvides the features required fr directly prvisining the device running the Gateway Agent remtely and securely, and acts much like a machine driven Cntrl App t prvisin the clud services. The Service Prvider Mde is implemented using secure and prven remte management based n the TR-069 family f standards frm Bradband Frum. AllSeen Alliance Gateway Agent W.G.8/12/ DRAFT 1 Page 1 f 5

2 Service Prvider Mde Remte Management Requirements 1. Autmatically register a new Gateway Agent device and the subscriber (user) fr the clud services when it is installed 2. At the time f new services activatin enable installatin f a new Cnnectr App remtely (frm utside f the prximal netwrk) if it is required fr the new clud services. 3. Multiple Cnnectr Apps are supprted in Service Prvider Mde. Each can be remtely managed, even if riginally installed by the subscriber frm a Cntrl App. 4. Add the capability t fr the Services Prvider t blck the custmer frm installing r mdifying Cnnectr Apps using the Cntrl App f the nn-enterprise Cnsumer Mde. 5. The Service Prvider Mde utilizes the same Cnnectr App requirements as the Cnsumer mde. This is key t enabling either type f services deplyment t be available withut requiring mdificatin f the Cnnectr App. Affinegy is cntributing a Cnnectr App that supprts the Gateway Agent HLD in either Cnsumer Mde r Service Prvider Mde. This is based n XMPP and will be separately dcumented as a reference sample Cnnectr App. This XMPP cnnectr prvides its wn remte access and NAT traversal, which is separate frm the Service Prvider Mde management. 6. A Cnnectr App that is installed thrugh the Service Prvider Mde will nrmally be lcked frm mdificatin by a Cntrl App in Cnsumer Mde. 7. Prfiles fr Service Prvider Mde may ptinally be synchrnized with the remte management server. 8. NAT traversal t enable remte management shall be supprted when the gateway device that is running the Gateway Agent is cnnected behind a NAT firewall. This will be perfrmed using either the TR 069 UDP based STUN methd, r the XMPP methd f TR 069a5. Bth methds will be available hwever the first release cntributin will be based n the STUN methd that is mature and prven. 9. Service Prvider Mde prvides additinal ptinal remte management features fr the Services Prvider. These relate primarily t the management f the hardware device that is running the Gateway Agent applicatin. Ability t update/replace the firmware image f the gateway device Ability t transfer remte management cntrl t a new service prvider dmain Ability t diagnse and manage varius settings f the gateway device that is running the Gateway Agent Nte - this first release fr Service Prvider Mde des nt include direct TR 069 based prxy management f the AllJyn LAN devices. This wuld verlap with the features f the Cnnectr App (fr example the XMPP Cnnectr) that is the basis fr remte messaging and management f the AllJyn devices. Hwever the fundatin is prvided t add TR-069 prxy management when desired fr prvisining f services t AllJyn LAN devices (such as cnfiguring individual IP cameras fr their vide server entries, etc). AllSeen Alliance Gateway Agent W.G.8/12/ DRAFT 1 Page 2 f 5

3 Service Prvider Mde Implementatin Architecture A very high level f security is critical fr the Service Prvider Mde. Services that are delivered in this fashin usually are part f a paid service subscriptin that includes cntractual service quality agreements. The remte management technlgy fr Service Prvider Mde is based n the Bradband Frum TR 069 family f standards. In particular TR 069 amendment 5 (the cre remte management prtcl and NAT traversal), and TR 157 which cvers sftware mdule installatin and management. The details f these standards are included here nly by reference. Security implicatins - in this services prvider mdel, the peratr has ttal cntrl f the gateway hardware device, including the ability t ttally replace all firmware in the device cnsistent with their wn agreement with their subscribers. The rles f the Cnnectr App and the Cntrl App are the same as in the HLD with the same security restrictins when used by the subscriber (user). With the Service Prvider Mde, hwever the TR 069 management can verride any ther setting in the Gateway, including thse made the their subcriber. The Services Prvider acts as a super administratr fr the device running the Gateway Agent in the Service Prvider Mde. Affinegy is cntributing its TR 069 embedded client fr Linux and integrated int OpenWRT fr this prject which implements these functins. Affinegy is further prviding develper access t its hsted TR 069 ACS remte management server, t enable easy prduct and services implementatin using these libraries. Since this implementatin fr Service Prvider Mde fully cmplies with the Bradband Frum standards - prducts that adpt these libraries will supprt any TR 069 ACS server that supprts the required standards. AllSeen Alliance Gateway Agent W.G.8/12/ DRAFT 1 Page 3 f 5

4 Architecture Diagram The diagram shws the new sftware cmpnents fr Service Prvider Mde that are added t enable the TR 069 remte management f cnnectr apps and the related clud prfiles. This diagram includes the same cmpnents as in the Nn-Enterprise / Cnsumer mde f the HLD - with the new cmpnents and new remte server added. Service Prvider Mde Architecture TR-069 Prtcl Remte Management RPCs TR-069 ACS Server Clud Service includes the TR-069 Server fr management App%Dwnlad% Server Clud% Service% Cntrl%App Clud<G>Cnnectr % App % web % prtcl Cnnectr App prtcl is selected by Clud services prvider. Cnnectr App can be cmpatible with either Service Prvider r Cnsumer Mde Cnnectr%app%package%dwnlad Cnnectr% SP%App App BA Client%Lib. Gateway%Agent App%install/upgrade/uninstall Gateway% % Management App Client%Lib. Package Manager % TR-069 CWMP client Cnfig%file%plicy%enfrcement AllJyn%Ruter! App%Mgmt%IF App%Install%Interactin Platfrm%based%interactin Service Prvider Mde interactin AllJyn% Devices Cntrl%App AllSeen Alliance Gateway Agent W.G.8/12/ DRAFT 1 Page 4 f 5

5 API and Specificatin Impacts fr the Gateway Agent HLD The Service Prvider Mde is implemented using standard specified requirements f the TR-069 and TR-157 standards as implemented and dcumented in Affinegy s client cde cntributins. The detailed principals f peratin are specified there. Links t these standards are prvided belw. In principal, the APIs and requirements f the Gateway Agent fr Cnsumer Mde are nt changed. Hwever, there are specific interface API needs between the TR-069 embedded CWMP client t integrate the mde switch t in the Gateway Agent applicatin t supprt the new Service Prvider Mde. These have n external access except via the TR-069 remte cmmands t the embedded TR-069 client. Essentially nly a mde switch parameter is needed, hwever this may tuch several places in the current cde which is left fr detailed review and discussin fr implementatin within the prject team. Bradband Frum Standards References The main prtcl standard fr TR The standard fr sftware mdule management: AllSeen Alliance Gateway Agent W.G.8/12/ DRAFT 1 Page 5 f 5