Lightspeed Filter Agent v2.0.0

MrR0g3rs
New Contributor III

Lightspeed just released the newest version of filter agent that completely changes how it works based on Apple's system extensions. This is completely different from the way it worked before. If I were to update it via auto update it would give the users a number of permission prompts that they could decline. LS released some documentation for updating these permissions automatically via MDM but frankly the instructions are kind of confusing for a relative newb. Could one of you kind experts perhaps take a look at these instructions and boil down what I need to do? Thanks in advance!

1 ACCEPTED SOLUTION

mmcallister
Contributor II

You'll want configuration profiles to install the ca.cer certificate (Certificate payload) and the deployment_jamf.plist (Application and Custom Settings payload).  You will also want a profile for the System Extension to suppress the security prompts.

Scope the configuration profile(s), and then use a policy to install the 2 .PKGs.

The system extension was the bit I had to fiddle with the most to get correct, so I've included some screenshots from my JSS that might be helpful.

Screen Shot 2022-06-10 at 8.58.03 AM.png

 

Screen Shot 2022-06-10 at 8.58.22 AM.png

 

View solution in original post

9 REPLIES 9

jbisgett
Contributor II

It is very wordy. The process is not complicated, but there are a lot of pieces to making it work properly that have to be done in a certain order.

Basically, you need to create some new profiles that will pre-approve the network extension and socket filtering to suppress the permission prompts on devices, as outlined in steps 5 & 6 under MDM deployment in the guide that you linked.

5.) Configure Content Filter Payload

Jamf requires that the following Team ID and Bundle IDs are added as approved System Extensions. Jamf will also have you approve specific System Extension types. If this is the case, use the same information below to also approve these System Extensions with Network as the type.

  • Team ID: ZAGTUU2342
  • System Extension Bundle IDs
    • com.lightspeedsystems.network-agent
    • com.lightspeedsystems.network-agent.network-extension

6.) Configure Content Filter Payload

Jamf will want to configure a content filter payload to pre-approve the security prompts when the Network Extension asks to filter the device. Use the settings below when setting this up.

  • Filter Name (found at System Preferences > Network): Lightspeed Agent
  • Identifier: com.lightspeedsystems.network-agent
  • Filter Order: Firewall (Give this the highest priority setting available)
  • When adding, select Socket Filter and use the following values:
    • Socket Filter Bundle Identifier: com.lightspeedsystems.network-agent.network-extension
    • Socket Filter Designated Requirement:
      anchor apple generic and identifier "com.lightspeedsystems.network-agent.network-extension" and (certificate leaf[field.1.2.840.113635.100.6.1.9] /* exists */ or certificate 1[field.1.2.840.113635.100.6.2.6] /* exists */ and certificate leaf[field.1.2.840.113635.100.6.1.13] /* exists */ and certificate leaf[subject.OU] = ZAGTUU2342)

That's it for what's needed for the autoupdate to work successfully.

There is another consideration, however, that you will need to check on: the certificate utilized by Relay for filtering. The autoupdate will NOT renew the CA certificate used by Relay for filtering, so you will need to renew this certificate manually before the expiration date. You would use the create_deploy utility included on the SmartAgent.dmg that you can download from Relay to generate a new root CA and deploy to your fleet. By doing this, you will also need to re-deploy the necessary ETC files needed by the root CA. This can be done automatically with Lightspeed's new utility agent, also included on the .dmg. Please look at the Generate Certificate section of the documentation you linked for the steps on this.

Again, basically, you will use the create_deploy to generate the certificate and deployment files needed. Upload the new certificate to Jamf and deploy to fleet (this can be in a new profile deployed alongside your existing Relay certificate, the old one will be used until the other files are replaced and the services restarted). Upload the deployment_jamf.plist to a configuration profile, deploy to fleet. Once the profile is on the device, have a policy to install the LightSpeed utility agent. This will create the support files needed by the new CA, copy them to the ETC folder (overwriting the existing files), then restart the services to use the new files.

Test, test, test, and test some more to make sure everything works as intended before deploying anything to entire fleet.

jbisgett
Contributor II

There are 3 main scenarios that need to be planned for:

  1. Automated upgrade to 2.0 using the Relay portal from version 1.7.7
    1. Before upgrading, create two configuration profiles in Jamf and deploy to your target devices
      1. Configure Content Filter Payload
        1. Jamf will require that the following Team ID and Bundle IDs are added as approved System Extensions. Jamf also has you approve specific System Extension types. Use the same information below to also approve these System Extensions with Network as the type.
          Team ID: ZAGTUU2342
          System Extension Bundle IDs: com.lightspeedsystems.network-agent
          com.lightspeedsystems.network-agent.network-extension
        2. Jamf will want to configure a content filter payload to pre-approve the security prompts when the Network Extension asks to filter the device. Use the settings below when setting this up.
          Filter Name (found at System Preferences > Network): Lightspeed Agent Identifier: com.lightspeedsystems.network-agent
          Filter Order: Firewall (Give this the highest priority setting available)
          When adding, select Socket Filter and use the following values:
          Socket Filter Bundle Identifier: com.lightspeedsystems.network-agent.network-extension
          Socket Filter Designated Requirement: anchor apple generic and identifier "com.lightspeedsystems.network-agent.network-extension" and (certificate leaf[field.1.2.840.113635.100.6.1.9] /* exists */ or certificate 1[field.1.2.840.113635.100.6.2.6] /* exists */ and certificate leaf[field.1.2.840.113635.100.6.1.13] /* exists */ and certificate leaf[subject.OU] = ZAGTUU2342)
      2. Manually install Relay 2.0 on a test device with the profiles to make sure the prompts don't show and that the filtering works as expected.
      3. After successful tests, set 2.0 as default install in Relay portal

    2. Fresh install of Smart Agent 2.0 on a device
      1. Ensure that your current Relay certificate, corresponding ETC files, and 2 new configuration profiles are installed on the device before installing 2.0
    3. Updating the certificate used by Relay for filtering
      1. This is the most complicated part of the process
        1. Using the create_deploy script on the SmartAgent 2.0 dmg, generate the deployment files (new CA certificate, ETC files, and deployment plists)
        2. Upload the new CA to a new configuration profile in Jamf for deployment. (This profile can be deployed alongside the existing CA, the new one won't be used until the rest of the deployment files are in place and the services have been restarted).
        3. You can do the next part one of two ways
          1. Package the ca_key.pem, ca.pem, localhost.pem, and localhost_key.pem generated with the new certificate using Composer and deploy to /usr/local/etc
            1. Either manually restart the filtering service or restart the computer for the new files to be used

          2. Use Lightspeed's new Utility Agent to create the required support files and copy to the correct location
            1. Look for deployment_jamf.plist in the same place as the generate deployment files.
            2. Upload that to a configuration profile in Jamf and deploy to targets
            3. Deploy LightspeedUtilityAgent.pkg to targets (it will create the files in /usr/local/etc and restart the filtering service automatically to use the new files)

With any of these methods, test, test, test, and test some more to make sure that Relay is filtering properly after each installation type BEFORE mass deploying to your entire fleet. I am still in the process of doing my testing, which I hope to have completed next week. Also, you may want to wait on 2.0.3 before updating your clients, since that has some fixes they are working on for twitter and amazon decryption.

dwaterbury
New Contributor III

I'm confused as to which route would be better to go.  Copy the /usr/local/etc files using composer and push it out.

Or

To push out the depoloyment_jamf.plist file and have a policy to Install the Lightspeed Utility Agent.pkg

 

Are there any major differences anyone has noticed to recommend one direction over another?

Both methods worked for me. @jbisgett mentioned in his writeup that placing the files directly into /usr/local/etc required a restart, but we have one set already as part of our deployment policy so I don't know if that's actually required.

It could be argued that placing the files directly is safer in some way, because the .plist/Utility Agent method leaves the RSA private key visible in System Preferences/Profiles

jbisgett
Contributor II

Ok, I've posted explanations three times now and each time the forum refuses to save my post. Please join the #lightspeed channel in MacAdmins Slack, there are lots of discussions there on how others are deploying the new agent.

MrR0g3rs
New Contributor III

Could you let me know how to join this Slack channel?

mmcallister
Contributor II

You'll want configuration profiles to install the ca.cer certificate (Certificate payload) and the deployment_jamf.plist (Application and Custom Settings payload).  You will also want a profile for the System Extension to suppress the security prompts.

Scope the configuration profile(s), and then use a policy to install the 2 .PKGs.

The system extension was the bit I had to fiddle with the most to get correct, so I've included some screenshots from my JSS that might be helpful.

Screen Shot 2022-06-10 at 8.58.03 AM.png

 

Screen Shot 2022-06-10 at 8.58.22 AM.png

 

MrR0g3rs
New Contributor III

Thank you! This helped. Successfully deployed.

Sandy
Valued Contributor II

New info here regarding the error "The Team ID may not appear in both Allowed Team Identifiers and Allowed System Extensions"