1 lawrence.luo 1.2 //%LICENSE////////////////////////////////////////////////////////////////
 2                  //
 3                  // Licensed to The Open Group (TOG) under one or more contributor license
 4                  // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
 5                  // this work for additional information regarding copyright ownership.
 6                  // Each contributor licenses this file to you under the OpenPegasus Open
 7                  // Source License; you may not use this file except in compliance with the
 8                  // License.
 9                  //
10                  // Permission is hereby granted, free of charge, to any person obtaining a
11                  // copy of this software and associated documentation files (the "Software"),
12                  // to deal in the Software without restriction, including without limitation
13                  // the rights to use, copy, modify, merge, publish, distribute, sublicense,
14                  // and/or sell copies of the Software, and to permit persons to whom the
15                  // Software is furnished to do so, subject to the following conditions:
16                  //
17                  // The above copyright notice and this permission notice shall be included
18                  // in all copies or substantial portions of the Software.
19                  //
20                  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21                  // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 lawrence.luo 1.2 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23                  // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24                  // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25                  // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26                  // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27                  //
28                  //////////////////////////////////////////////////////////////////////////
29                  
30                  
31                  Wed Oct 23 2013
32                  
33                  What is webadmin?
34                  =================
35                  Pegasus webadmin interface provides a limited edition of administering the
36                  cimserver through web. Currently, modification of cimserver config options
37                  viewing the Providers registered and subscriptions view are supported. In
38                  future, management of subscriptions and provider management will be added.
39                  In OpenPegasus 2.14, Webadmin is still in a experimental vesrion and will
40                  be improved in the future.
41                  
42                  How to build pegasus for using webadmin?
43 lawrence.luo 1.2 ========================================
44                  Building source files for webadmin will need to build for both CIM-RS and
45                  webadmin. CIM-RS is built as an integral part of server(not controlled by
46                  by build macros) and webadmin i controlled by PEGASUS_ENABLE_PROTOCOL_WEB,
47                  which is 'true by default'.
48                  To disable it set PEGASUS_ENABLE_PROTOCOL_WEB=false.
49                  
50                  What is relation between Webadmin and CIM-RS?
51                  =============================================
52                  webadmin interface's backbone is CIM-RS details at [1] and webserver facility
53                  built on pegasus. CIM-RS accepts/yields payloads represented as JSON[2]. The 
54                  response in JSON can be consumed by webserver easily, for example through 
55                  javascripti, for displaying as a webpage.
56                  
57                  How do I bring up the webadmin?
58                  ===============================
59                  Enter the your local host name along with port number in the address bar of a
60                  browser. For example, if your hostname is localhost.localdomain. Just type in
61                  localhost.localdomain:5988. 
62                  
63                  Which ports do CIM-RS aand webadmin use?
64 lawrence.luo 1.2 ==================
65                  Webadmin and CIM-RS currently uses the DMTF's CIMOM ports i.e 5988(http) and
66                  5989(https). This port will be updated with dedicated port for CIM-RS when
67                  available.
68                  
69                  Is there any security concerns for webadmin?
70                  =================================================
71                  In order to avoid modifying the server config options by any users, pegasus 
72                  should be started with 'enableAuthentication=true' which forces users to login
73                  for the webadmin.
74                  and in order to restrict to particular groups, 'authorizedUserGroups' should be
75                  set to the groups, whose members should be allowed to modify the config
76                  options.
77                  EnableAuthentication and authorizedUserGroups details can be found in manpage 
78                  of cimconfig(8)
79                  
80                  
81                  References:
82                  ===========
83                  1 http://www.dmtf.org/sites/default/files/standards/documents/DSP0210_1.0.0.pdf
84                  2 http://www.dmtf.org/sites/default/files/standards/documents/DSP0211_1.0.0.pdf