# mulesoft Kerberos Module - Full Documentation

<!-- document id=3184a749ae8c5480df8c95f4d0dffa3a7779e22109239ad333fb1f373cf2baa1 url=/mulesoft/current/en-us/kerberos-module/latest/index.md -->

---
product: Kerberos Module
version: 1.0
is-latest-version: true
---

# Kerberos Module 1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Kerberos Module adds Kerberos (SPNEGO) proxy authentication support for the Mule HTTP Connector.

> [!NOTE] The Kerberos module supports only proxy authentication and doesn’t implement request-based
> Kerberos authentication for HTTP requests.

## Before You Begin

To use this module, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- Creating a Mule app using Anypoint Studio

Before creating an app, you must have:

- Mule runtime 4.10.0 or later

- HTTP Connector 1.11 or later

- Anypoint Studio or Anypoint Code Builder

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=fb339659209f60e56f7ff32fc27f8824a52be3ae3ffe416c396ae14ea45f03a8 url=/mulesoft/current/en-us/kerberos-module/latest/kerberos-module-reference.md -->

---
product: Kerberos Module
version: 1.0
is-latest-version: true
---

# Kerberos Module 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Kerberos Module adds Kerberos (SPNEGO) proxy authentication support for the Mule HTTP Connector.

## Configuration

### Kerberos Proxy Authentication

Use `<kerberos:proxy-authentication>` to configure Kerberos proxy authentication for the Mule HTTP
Connector.

To use this module, set these system properties when starting Mule:

- HTTP Service Implementation: For Mule 4.10.x, this module requires the Netty HTTP service.

Add this JVM property:

```text
-Dmule.http.service.implementation=NETTY
```

- Kerberos Configuration File: Provide the path to your organization’s krb5.conf file. You can reuse
  an existing path if other modules already use it.

Add this JVM property:

```text
-Djava.security.krb5.conf=/path/to/your/krb5.conf
```

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Proxy host.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Proxy port.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Principal</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Kerberos principal, for example, <code>user@EXAMPLE.COM</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Realm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Kerberos realm, for example, <code>EXAMPLE.COM</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Use Ticket Cache</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, uses the local Kerberos ticket cache. If <code>false</code> (default), requires <code>keytabPath</code>.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Keytab Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to a keytab file.</p></div></div></td><td><div></div></td><td><div><div><p>Required when <code>useTicketCache</code> is <code>false</code> (default).</p></div></div></td></tr><tr><td><p><strong>Ticket Cache Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to Kerberos credential cache file. Only used when <code>useTicketCache</code> is <code>true</code>. Defaults to system ticket cache location.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Hosts to reach directly, bypassing the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Service Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Kerberos service type for building the SPN.</p></div></div></td><td><div><div><p>HTTP</p></div></div></td><td><div></div></td></tr></tbody></table>

#### XML Example

Use `<kerberos:proxy-authentication>` to configure Kerberos proxy authentication in an HTTP
Connector request configuration. This example shows how to set parameters such as `host`, `port`,
`principal`, `realm`, `useTicketCache`, and `serviceType`.

```xml
<mule xmlns:kerberos="http://www.mulesoft.org/schema/mule/kerberos"
      xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
                          http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
                          http://www.mulesoft.org/schema/mule/kerberos http://www.mulesoft.org/schema/mule/kerberos/current/mule-kerberos.xsd">

  <http:request-config name="httpCfg">
    <http:proxy-config>
      <kerberos:proxy-authentication
          host="proxy.example.com"
          port="8080"
          principal="user@EXAMPLE.COM"
          realm="EXAMPLE.COM"
          keytabPath="/path/to/file.keytab"
          serviceType="HTTP"/>
    </http:proxy-config>
  </http:request-config>

</mule>
```

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=fc1964ad0b91eff4f7e1b380b39c0351def8820fcff4d07a128795077f033e77 url=/mulesoft/current/en-us/kerberos-module/latest/kerberos-xml-maven.md -->

---
product: Kerberos Module
version: 1.0
is-latest-version: true
---

# Kerberos Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it’s more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste this code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/kerberos
http://www.mulesoft.org/schema/mule/kerberos/current/mule-kerberos.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:kerberos="http://www.mulesoft.org/schema/mule/kerberos"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/kerberos
	http://www.mulesoft.org/schema/mule/kerberos/current/mule-kerberos.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-kerberos-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you’re using.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)