DACS.SERVICES(8)

Name
dacs.services - DACS web services

Synopsis

dacswebservice [dacsoptions[1]]

DESCRIPTION

These web services are part of the DACS suite.

The following is a list of DACS web services with a brief description of each. General aspects of DACS and its web services are discussed in dacs(1)[2]. Individual web services are discussed in more detail elsewhere. By default, these CGI programs are installed in the dacs subdirectory of the Apache cgi-bin directory.

By convention, DACS web service names use underscores as word separators. Some web services have command counterparts; their names omit the underscores.

    •

        dacs_admin
        A low-level administration tool for DACS.
        [dacs_admin(8)[3]]

    •

        dacs_auth_agent
        Authenticate by delegating responsibility to a trusted identity.
        [dacs_auth_agent(8)[4]]

    •

        dacs_auth_transfer
        Transfer credentials between federations.
        [dacs_auth_transfer(8)[5]]

    •

        dacs_authenticate
        The DACS authentication service.
        [dacs_authenticate(8)[6]]

    •

        dacs_conf
        Process and display DACS configuration files.
        [dacs_conf(8)[7]]

    •

        dacs_current_credentials
        Display elements of each set of credentials sent with the request.
        [dacs_current_credentials(8)[8]]

    •

        dacs_error
        Simple error handler.
        [dacs_error(8)[9]]

    •

        dacs_group
        A DACS group administration tool.
        [dacs.groups(5)[10]]

    •

        dacs_list_jurisdictions
        Display information about all jurisdictions in a federation.
        [dacs_list_jurisdictions(8)[11]]

    •

        dacs_notices
        Notice presentation and acknowledgement handler.
        [dacs_notices(8)[12]]

    •

        dacs_passwd
        Administration tool for passwords used by local_passwd_authenticate.
        [dacs_passwd(8)[13]]

    •

        dacs_prenv
        Display environment variables.
        [dacs_prenv(8)[14]]

    •

        dacs_select_credentials
        Temporarily disable credentials.
        [dacs_select_credentials(8)[15]]

    •

        dacs_signout
        Typically called from a browser, this web services causes one or more
        cookies (each representing a DACS identity) to be deleted.
        Cookies are automatically deleted when a browser terminates, but it
        is sometimes useful to explicitly logoff.
        [dacs_signout(8)[16]]

    •

        dacs_version
        Display version information.
        [dacs_version(8)[17]]

    •

        dacs_token
        Manage one-time password token accounts.
        [dacs_token(8)[18]]

    •

        dacs_transform
        Rule-based document transformation.
        [dacs_transform(8)[19]]

    •

        dacs_uproxy
        Minimal HTTP proxying.
        [dacs_uproxy(8)[20]]

    •

        dacs_vfs
        Manage items in the DACS virtual filestore.
        [dacs_vfs(8)[21]]

    •

        local_*_authenticate
        Authentication modules used by dacs_authenticate(8)[6].
        Each one implements a particular authentication method and optionally
        returns role information.

    •

        local_*_roles
        Roles modules used by dacs_authenticate(8)[6].

    •

        dacs_infocard, dacs_managed_infocard, dacs_mex, dacs_sts
        InfoCard support.
        [dacs_infocard(8)[22], dacs_managed_infocard(8)[23], dacs_mex(8)[24], dacs_sts(8)[25]]

  Standard CGI Arguments for DACS Web Services

The following set of CGI arguments are recognized by most DACS web services. When the document for a DACS web service says that it accepts "the standard CGI arguments", it is referring to the following arguments; not all of these arguments are necessarily meaningful to all web services, however.

In general, duplicate CGI argument names are not allowed; i.e., you cannot pass an argument named DACS_JURISDICTION more than once when calling a DACS web service, even if each occurrence of the argument has the same value.

DACS_JURISDICTION
    This argument is required by most web services. It specifies the name of the jurisdiction to which the request is being sent. Web services will verify that the jurisdiction that receives the request is the same as the intended recipient.

DACS_VERSION
    If this argument is present, it specifies the major DACS version number (e.g., 1.4) expected by the client. The service request will fail if the DACS software does not support this version number. If not provided, no compatibility checks are performed.

FILE
    Reserved for future use for file uploading. Requests content type application/x-dacs-credentials.

FORMAT
    This optional argument requests a particular output format. The default value varies, but it is usually HTML. Not all formats are supported by every web service; refer to the manual page for details. The following values may be recognized:

    HTML
        Requests content type text/html;

    JSON
        Requests content type application/json (JavaScript Object Notation, see www.json.org[26], ECMA-404[27], RFC 4627[28], and RFC 7159[29]);

    PHP
        Used by the dacs_list_jurisdictions(8)[11] web service when its output is to processed by PHP;

    PLAIN
        Requests content type text/plain;

    TEXT
        Like PLAIN except that no content type is specified;

    URI
        An encoding based on RFC 2396[30];

    URL
        Equivalent to URI;

    XML
        Requests content type text/xml. If the DTD_BASE_URL directive is configured, a DOCTYPE element with the keyword SYSTEM followed by a value derived from DTD_BASE_URL is emitted; e.g.,

            <!DOCTYPE foo SYSTEM "http://fedroot.com/dacs/dtd-xsd/foo.dtd">

        If DTD_BASE_URL is not configured, an internal DTD is emitted. A default xmlns attribute is emitted in both cases;

    XMLDTD
        Requests content type text/xml This emits an internal DTD and default xmlns attribute;

    XMLSCHEMA
        Requests content type text/xml. If the XSD_BASE_URL directive is configured, xmlns:xsi and xsi:schemaLocation attributes are emitted, the former having a compile-time value (e.g., "http://www.w3.org/2001/XMLSchema-instance") and the latter being a pair, the first having the same value as the value of the xmlns attribute and the second having a value derived from XSD_BASE_URL; e.g.,

            <foo xmlns="http://fedroot.com/dacs/v1.4"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:schemaLocation="http://fedroot.com/dacs/v1.4
                http://amd.dss.bc.ca/dacs/dtd-xsd/foo.xsd">

        The default xmlns attribute is also emitted. If XSD_BASE_URL is not configured, only the default xmlns attribute is emitted; and

    XMLSIMPLE
        Requests content type text/xml Neither a DTD (no DOCTYPE) nor a default xmlns attribute is emitted.

    Also see the -format[31] command line flag (one of the dacsoptions[1]).

DIAGNOSTICS

Programs usually exit 0 if everything was fine, 1 if an error occurred.

AUTHOR

Distributed Systems Software (www.dss.ca[32])

COPYING

Copyright © 2003-2014 Distributed Systems Software. See the LICENSE[33] file that accompanies the distribution for licensing information.

Notes

1.  dacsoptions
    http://dacs.dss.ca/man/dacs.1.html#dacsoptions

2.  dacs(1)
    http://dacs.dss.ca/man/dacs.1.html

3.  dacs_admin(8)
    http://dacs.dss.ca/man/dacs_admin.8.html

4.  dacs_auth_agent(8)
    http://dacs.dss.ca/man/dacs_auth_agent.8.html

5.  dacs_auth_transfer(8)
    http://dacs.dss.ca/man/dacs_auth_transfer.8.html

6.  dacs_authenticate(8)
    http://dacs.dss.ca/man/dacs_authenticate.8.html

7.  dacs_conf(8)
    http://dacs.dss.ca/man/dacs_conf.8.html

8.  dacs_current_credentials(8)
    http://dacs.dss.ca/man/dacs_current_credentials.8.html

9.  dacs_error(8)
    http://dacs.dss.ca/man/dacs_error.8.html

10. dacs.groups(5)
    http://dacs.dss.ca/man/dacs.groups.5.html

11. dacs_list_jurisdictions(8)
    http://dacs.dss.ca/man/dacs_list_jurisdictions.8.html

12. dacs_notices(8)
    http://dacs.dss.ca/man/dacs_notices.8.html

13. dacs_passwd(8)
    http://dacs.dss.ca/man/dacs_passwd.8.html

14. dacs_prenv(8)
    http://dacs.dss.ca/man/dacs_prenv.8.html

15. dacs_select_credentials(8)
    http://dacs.dss.ca/man/dacs_select_credentials.8.html

16. dacs_signout(8)
    http://dacs.dss.ca/man/dacs_signout.8.html

17. dacs_version(8)
    http://dacs.dss.ca/man/dacs_version.8.html

18. dacs_token(8)
    http://dacs.dss.ca/man/dacs_token.8.html

19. dacs_transform(8)
    http://dacs.dss.ca/man/dacs_transform.8.html

20. dacs_uproxy(8)
    http://dacs.dss.ca/man/dacs_uproxy.8.html

21. dacs_vfs(8)
    http://dacs.dss.ca/man/dacs_vfs.8.html

22. dacs_infocard(8)
    http://dacs.dss.ca/man/dacs_infocard.8.html

23. dacs_managed_infocard(8)
    http://dacs.dss.ca/man/dacs_managed_infocard.8.html

24. dacs_mex(8)
    http://dacs.dss.ca/man/dacs_mex.8.html

25. dacs_sts(8)
    http://dacs.dss.ca/man/dacs_sts.8.html

26. www.json.org
    http://www.json.org

27. ECMA-404
    http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf

28. RFC 4627
    http://www.rfc-editor.org/rfc/rfc4627.txt

29. RFC 7159
    http://www.rfc-editor.org/rfc/rfc7159.txt

30. RFC 2396
    http://www.rfc-editor.org/rfc/rfc2396.txt

31. -format
    http://dacs.dss.ca/man/dacs.1.html#format-arg

32. www.dss.ca
    http://www.dss.ca

33. LICENSE
    http://dacs.dss.ca/man/../misc/LICENSE