<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
  <header>
    <title>Simple Access Control</title>
    <abstract>A simple protocol for querying information for permissions.</abstract>
    
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<permissions>Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.</permissions>
<warranty>## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##</warranty>
<liability>In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.</liability>
<conformance>This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
    <number>0074</number>
    <status>Retracted</status>
    <type>Standards Track</type>
    <sig>Standards</sig>
    <approver>Council</approver>
    <dependencies><spec>XEP-0030</spec></dependencies>
    <supersedes/>
    <supersededby/>
    <shortname>sac</shortname>
    <author>
      <firstname>Justin</firstname>
      <surname>Kirby</surname>
      <email>justin@openaether.org</email>
      <jid>zion@openaether.org</jid>
    </author>
    <revision>
      <version>0.2</version>
      <date>2003-10-20</date>
      <initials>psa</initials>
      <remark>At the request of the author, changed status to Retracted.</remark>
    </revision>
    <revision>
      <version>0.1</version>
      <date>2003-03-05</date>
      <initials>jk</initials>
      <remark>Initial version.</remark>
    </revision>
  </header>
  <section1 topic="Introduction">
    <p>A Jabber travels further into the Jabber-as-Middleware world, it needs a protocol to determine "who can do what to whom". This proposal defines a protocol that enables any Jabber entity to determine the permissions of another Jabber entity, whether the context is a user JID querying a component for access, a client-to-client conversation, or a component asking another component about a request from a user.</p>
    <p>All access control lists (ACLs) boil down to three aspects: Actor, Operation, and Target/Sink. With this in mind it becomes almost trivial to implement the basic query/response mechanism.</p>
    <example caption="A simple query">
      <![CDATA[
	<iq to="security.capulet.com"
	    from="inventory.capulet.com"
	    type="get" id="1234">
	  <acl xmlns="http://jabber.org/protocol/sac"
	       actor="juliet@capulet.com/church"
	       oper="uri://capulet.com/inventory#obtain"
	       target="poison"/>
	</iq>
]]>
    </example>
    <p>Here we have the inventory.capulet.com component querying the security component as to whether juliet@ may obtain the requested poison.</p>
    <example caption="A response to the above query">
      <![CDATA[
	<iq to="inventory.capulet.com"
	    from="security.capulet.com"
	    type="result" id="1234">
	  <acl xmlns="http://jabber.org/protocol/sac"
	       actor="juliet@capulet.com/church"
	       oper="uri://capulet.com/inventory#obtain"
	       target="poison">
	    <allowed/>
	  </acl>
	</iq>
]]>
    </example>
    <p>Unfortunately, the response is in the affirmative and the romantic tragedy follows.</p>
  </section1>
  <section1 topic="A More Formal Tone">
    <p>The &lt;acl&gt; element provides the container for the query. It MUST have the three attributes: actor, oper, and target.</p>
    <p>The actor attribute is set to the Jabber ID which is attempting to perform an operation. This need not be the JID sending the acl, although it may be. Remember this is to allow for the question, "Can X do Y to Z?", which is a question anyone can ask.</p>
    <p>The oper attribute is application-specific and refers to the operation for which a permission check is required (e.g., read/write operations). This also defines the scope of the ACL check, so the implementation is responsible for interpreting the actor and target values based on the value of the 'oper' attribute.</p>
    <p>The target is the object which the actor is trying to perform the operation on. This MUST be a node queryable via <span class="ref"><link url="https://xmpp.org/extensions/xep-0030.html">Service Discovery (XEP-0030)</link></span> <note>XEP-0030: Service Discovery &lt;<link url="https://xmpp.org/extensions/xep-0030.html">https://xmpp.org/extensions/xep-0030.html</link>&gt;.</note>.</p>
    <p>Requests MUST be in the form of an empty &lt;acl/&gt; element with ALL the attributes specified. If not all attributes are specified, the request is incomplete and ambiguities arise; therefore the entity receving the request MUST return a "bad request" error to the sender. </p>
    <p>Responses MUST be in one of three forms: allowed, denied, error.</p>
    <p>The response is inserted into the &lt;acl/&gt; as a child element. If the response is allowed, then &lt;allowed/&gt; is inserted. If the JID is denied then &lt;denied/&gt; is returned. If there is inadequate information then &lt;error/&gt; is used following the standard Jabber error scheme.</p>
    <example caption="A positive response">
      <![CDATA[
	<iq to="inventory.capulet.com"
	    from="security.capulet.com"
	    type="result" id="1234">
	  <acl xmlns="http://jabber.org/protocol/sac"
	       actor="juliet@capulet.com/church"
	       oper="uri://capulet.com/inventory#obtain"
	       target="poison">
	    <allowed/>
	  </acl>
	</iq>
]]>
    </example>
    <example caption="Negative response (denied)">
      <![CDATA[
	<iq to="inventory.capulet.com"
	    from="security.capulet.com"
	    type="result" id="1234">
	  <acl xmlns="http://jabber.org/protocol/sac"
	       actor="juliet@capulet.com/church"
	       oper="uri://capulet.com/inventory#obtain"
	       target="poison">
	    <denied/>
	  </acl>
	</iq>
]]>
    </example>
    <example caption="Error response">
      <![CDATA[
	<iq to="inventory.capulet.com"
	    from="security.capulet.com"
	    type="error" id="1234">
	  <acl xmlns="http://jabber.org/protocol/sac"
	       actor="juliet@capulet.com/church"
	       oper="uri://capulet.com/inventory#obtain"
	       target="poison"/>
	  <error code="404">No information available</error>
	</iq>
]]>
    </example>
  </section1>
  <section1 topic="Query List of ACL operations">
    <p>To obtain a list of acl operations that a jid supports, you must send an empty &lt;query/&gt; </p>
    <example caption="querying for list of acl operations">
      <![CDATA[
	<iq to="security.capulet.com"
	    from="inventory.capulet.com"
	    type="get" id="1234">
	  <query xmlns="http://jabber.org/protocol/sac"/>
	</iq>
]]>
    </example>
    <p>The to jid must then respond with a list of operations, if the jid supports SAC.</p>
    <example caption="response to the query">
      <![CDATA[
	<iq to="inventory.capulet.com"
	    from="security.capulet.com"
	    type="result" id="1234">
	  <query xmlns="http://jabber.org/protocol/sac">
	    <oper uri="uri://capulet.com/inventory#obtain"/>
	    <oper uri="uri://capulet.com/inventory#add"/>
	    <oper uri="uri://capulet.com/inventory#remove"/>
	  </query>
	</iq>
]]>
    </example>
  </section1>
  <section1 topic="Integrating with Service Discovery">
    <p>To follow.</p>
  </section1>
  <section1 topic="Security Considerations">
    <p>To follow.</p>
  </section1>
  <section1 topic="IANA Considerations">
    <p>This document requires no interaction with the <span class="ref"><link url="http://www.iana.org/">Internet Assigned Numbers Authority (IANA)</link></span> <note>The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see &lt;<link url="http://www.iana.org/">http://www.iana.org/</link>&gt;.</note>.</p>
  </section1>
  <section1 topic="XMPP Registrar Considerations" anchor="registrar">
    <p>As a result of this document, the <span class="ref"><link url="https://xmpp.org/registrar/">XMPP Registrar</link></span> <note>The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see &lt;<link url="https://xmpp.org/registrar/">https://xmpp.org/registrar/</link>&gt;.</note> will need to register the 'http://jabber.org/protocol/sac' namespace.</p>
  </section1>
  <section1 topic="Open Issues">
    <ol>
      <li>Add disco integration section.</li>
      <li>Fill out error codes.</li>
      <li>Add DTD and Schema.</li>
      <li>Allow for query of all allowable operations for actor in relation to a target.</li>
      <li>Investigate possible integration with pubsub.</li>
    </ol>
  </section1>
</xep>
