Repository files navigation

Go library and tooling for working with EZproxy.

• Project home
• Status
• Overview
• Features
  • Current
  • Missing
• Changelog
• Documentation
• Examples
• License
• References
  • Related projects
  • Official EZproxy docs

Seeour GitHub repo for the latest code, to file an issue orsubmit improvements for review and potential inclusion into the project.

Alpha; very much getting a feel for how the project will be structuredlong-term and what functionality will be offered.

The existing functionality was added specifically to support thein-developmentatc0005/brick. This library is subjectto change in order to better support that project.

This library is intended to provide common EZproxy-related functionality suchas reporting or terminating active login sessions (either for all usernames orspecific usernames), filtering (or not) audit file entries or traffic patterns(not implemented yet) for specific usernames or domains.

See theInput file formats doc for additional detailsregarding known and supported input file formats.

Just to be perfectly clear:

• this library is intended to supplement the provided functionality of theofficial OCLC-developed/supportedEZproxy application, not in any wayreplace it.
• this library is not in any way associated with OCLC,EZproxy or otherservices offered by OCLC.

• generate a list of audit records for session-related events

  • for all usernames
  • for a specific username

• generate a list of active sessions using the audit log

  • using entires without a corresponding logout event type

• generate a list of active sessions using the active file

  • for all usernames
  • for a specific username

• terminate user sessions

  • single user session
  • bulk user sessions

• Anything to do with traffic log entries
• Examples

See theCHANGELOG.md file for the changes associated witheach release of this application. Changes that have been merged tomaster,but not yet an official release may also be noted in the file under theUnreleased section. A helpful link to the Git commit history since the lastofficial release is also provided for further review.

Please see:

• ourGoDoc coverage
• ourtopic-specific coverage

If something doesn't make sense, pleasefile an issue andnote what is (or was) unclear.

Please see ourGoDoc coverage for general usage and theexamples doc for a list of applications developed usingthis module.

Taken directly from theLICENSE andNOTICE.txt files:

Copyright 2020-Present Adam Chalkleyhttps://github.com/atc0005/go-ezproxy/blob/master/LICENSELicensed under the Apache License, Version 2.0 (the "License"); you may not usethis file except in compliance with the License. You may obtain a copy of theLicense at    http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributedunder the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES ORCONDITIONS OF ANY KIND, either express or implied. See the License for thespecific language governing permissions and limitations under the License.

• atc0005/brick project

  • this project uses this library to provides tools (two as of this writing)intended to help manage login sessions.

• https://github.com/calvinm/ezproxy-abuse-checker

  • https://github.com/calvinm/ezproxy-abuse-checker/blob/d7202e617305745cf272df9918b1e95ff030f63f/block_user.pl#L32
  • this is the project that proved to me that EZproxy sessionscan beterminated programatically.

• https://help.oclc.org/Library_Management/EZproxy/EZproxy_configuration/EZproxy_system_elements
• https://help.oclc.org/Library_Management/EZproxy/Configure_resources/Audit
• https://help.oclc.org/Library_Management/EZproxy/Configure_resources/LogFormat
• https://help.oclc.org/Library_Management/EZproxy/Configure_resources/Option_LogSession
• https://help.oclc.org/Library_Management/EZproxy/Configure_resources/Option_LogUser
• https://help.oclc.org/Library_Management/EZproxy/Get_started/Join_the_EZproxy_listserv_and_Community_Center